-
Notifications
You must be signed in to change notification settings - Fork 4.3k
chore: update definition of breaking change in CONTRIBUTING.md #33368
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(This review is outdated)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #33368 +/- ##
=======================================
Coverage 80.92% 80.92%
=======================================
Files 236 236
Lines 14253 14253
Branches 2490 2490
=======================================
Hits 11534 11534
Misses 2434 2434
Partials 285 285
Flags with carried forward coverage won't be shown. Click here to find out more.
|
✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
| programs that customers could have been writing against the current version | ||
| of the CDK, that will no longer "work correctly" with the proposed new | ||
| version of the CDK. | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add "reason for this change" explanation to the readme possibly with the issue pointer? Its a great explanation. Removing this section will open up a debate on what and what is not a breaking change.
|
Comments on closed issues and PRs are hard for our team to see. |
Issue # (if applicable)
N/A
Reason for this change
The paragraph removed in this PR is too restrictive in defining breaking changes. It states that ANY change that may stop ANY CDK application to "not work correctly" is a breaking change. It is missing the point that we do not guarantee CDK applications that have custom logic or overriding CDK classes/methods, to not break. A recent case of this is #33319
Description of changes
Given that there is more concrete information on what defines a Breaking Change further down in
CONTRIBUTING.md, I have removed the inaccurate paragraphChecklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license