chore: update and simplify contribution guide #13525
Conversation
I've received feedback from some folks who would like to start contributing to the CDK but found the contribution guide unwieldy. Attempting to wittle down and simplify. Move content around so that useful information is at the top.
|
|
| but still *highly discouraged* in experimental libraries, and require explicit | ||
| callouts in the bodies of Pull Requests that introduce them. | ||
|
|
||
| > ¹) Note that starting in version 2 of the CDK, the majority of library code will be |
There was a problem hiding this comment.
Elad explicitly requested I was super explicit about this, which is why it's here.
Do you think it's not worthwhile? (I mean what the section says is sorta implied by the section before it, but again, explicitness...)
There was a problem hiding this comment.
Regarding the info on 'version 2': Not sure how useful this is to a contributor (yet). Usually, folks reading this docs are new contributors to the CDK. The note also feels more useful to users of the CDK than contributors.
About being 'highly discouraged' - it's not quite true. I'm quite permissive about breaking changes in modules that are very much in experimental area. In reality, this is somewhat discretionary, so best left out.
WDYT?
skinny85
dismissed
their stale review
Clicked "Approve" accidentally, was aiming for "Comment" ;p
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
I've received feedback from some folks who would like to start contributing to the CDK but found the contribution guide unwieldy. Attempting to wittle down and simplify. Move content around so that useful information is at the top. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
I've received feedback from some folks who would like to start contributing to the CDK but found the contribution guide unwieldy. Attempting to wittle down and simplify. Move content around so that useful information is at the top. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
I've received feedback from some folks who would like to start contributing to the CDK but found the contribution guide unwieldy. Attempting to wittle down and simplify. Move content around so that useful information is at the top. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
I've received feedback from some folks who would like to start
contributing to the CDK but found the contribution guide unwieldy.
Attempting to wittle down and simplify. Move content around so that
useful information is at the top.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license