docs(CONTRIBUTING): document guidance for preview APIs #16731
Conversation
With the commitment to not support breaking changes in stable modules (and all of aws-cdk-lib), we need to document the standard for introducing APIs we know to be potentially experimental or unstable. This standard was originally proposed in https://github.com/aws/aws-cdk-rfcs/blob/master/text/0249-v2-experiments.md, and was first actually used in #13780. This task documents the standard in the CONTRIBUTING guide so we can use it as a reference going forward. closes #16434
|
|
|
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 |
|
I believe there are places in our repo today that don't follow this guidance. They use Could you also make an announcement on the team email list about this? Feels like it warrants a wider PSA. |
With the commitment to not support breaking changes in stable modules (and all of aws-cdk-lib), we need to document the standard for introducing APIs we know to be potentially experimental or unstable. This standard was originally proposed in https://github.com/aws/aws-cdk-rfcs/blob/master/text/0249-v2-experiments.md, and was first actually used in aws#13780. This task documents the standard in the CONTRIBUTING guide so we can use it as a reference going forward. closes aws#16434 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
With the commitment to not support breaking changes in stable modules (and all
of aws-cdk-lib), we need to document the standard for introducing APIs we know
to be potentially experimental or unstable.
This standard was originally proposed in https://github.com/aws/aws-cdk-rfcs/blob/master/text/0249-v2-experiments.md, and
was first actually used in #13780.
This task documents the standard in the CONTRIBUTING guide so we can use it as a
reference going forward.
closes #16434
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license