Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a CDK style guide #1801

Open
marsavar opened this issue Apr 3, 2023 · 0 comments
Open

Create a CDK style guide #1801

marsavar opened this issue Apr 3, 2023 · 0 comments

Comments

@marsavar
Copy link
Contributor

marsavar commented Apr 3, 2023

Opening this issue as a result of a conversation with the DevX team.

CDK is extremely versatile, which means there are several approaches to solving any given problem, each with its own advantages and disadvantages. The purpose of a style guide would be provide guidance on the recommended way to solve common problems for consistency across the library.

Ultimately, there is a clear benefit to GuCDK consumers if resources follow the same patterns, not only in terms of API, but also in terms of usability, e.g. knowing where to look in the AWS console once a resource has been created.
Benefits of having a a style guide include: steering contributors towards the right direction, lessen the burden of PR reviewers (i.e. point contributors to the style guide instead of explaining things from scratch), help avoid having the same conversations once a consensus has been reached on how to solve an issue, etc.

Some ideas on what the style guide could include:

  • Recommended way to create policies (managed policies vs inline)
  • Recommended way to name a resource id
  • Recommended way to fix issues (i.e. introducing a breaking change vs fixing forward)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant