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.

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

Jump to bottom

doc: info on handling unintended breaking changes #47426

Merged
merged 2 commits into from
Apr 9, 2023
Merged

doc: info on handling unintended breaking changes #47426

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d93ab3
doc: info on handling unintended breaking changes
mhdawson Apr 5, 2023
4410a28
Update doc/contributing/collaborator-guide.md
mhdawson Apr 6, 2023
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
18 changes: 18 additions & 0 deletions doc/contributing/collaborator-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,24 @@ change. If such a change lands on the `main` branch, a collaborator can revert
it. As an alternative to reverting, the TSC can apply the semver-major label
after-the-fact.

If the change has already been backported to release lines open
an issue in the TSC repository to discuss how best to proceed. In the past
we have often reverted in the release lines and kept the change on main. The
decision to revert or not most often is based on limiting the impact
to the ecosystem and how quickly the breaking change is discovered.

If the change is reverted make sure to:

* consider if additional tests can be added to avoid a similar breaking change
being missed in the future.
* consider if adding packages to CITGM would have helped catch
the breaking change.
* ensure the changelog with the revert clearly explains the situation and
it's impact on those who may have already used the updated API.

In either case make sure that the documentation and changelog for the
original breaking change are updated to reflect the breaking behavior.

##### Reverting commits

Revert commits with `git revert <HASH>` or `git revert <FROM>..<TO>`. The
Expand Down