Skip to content

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

chore: update definition of breaking change in CONTRIBUTING.md #33368

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 1 addition & 7 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -823,7 +823,7 @@ console.log('This cannot be covered')

> [!NOTE]
> If your PR is failing one of the required checks (e.g Codecov), it will not be auto-merged. If you believe the PR should be merged
> inspite of this, let a maintainer know. The maintainer may agree and merge the PR manually, or ask you to address the failing checks.
> in spite of this, let a maintainer know. The maintainer may agree and merge the PR manually, or ask you to address the failing checks.


## Breaking Changes
Expand All @@ -836,12 +836,6 @@ _For v1, each module is separately released. For v2, only `stable` modules are r
_main `aws-cdk-lib` release, and all `experimental` modules are released independently as `-alpha` versions,_
_and not included in the main CDK library._

Whenever you are making changes, there is a chance for those changes to be
*breaking* existing users of the library. A change is breaking if there are
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.

Copy link
Contributor

@QuantumNeuralCoder QuantumNeuralCoder Feb 11, 2025

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.

Breaking changes are not allowed in *stable* libraries. They are permitted
in experimental libraries, unless the maintainer of the module decides that it should be avoided.
Breaking changes require explicit callouts in the bodies of Pull Requests that introduce them.
Expand Down
Loading