Nodejs/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-11-21 10:59:27 +00:00
Code Issues Actions 25 Packages Projects Releases Wiki Activity

doc: info on handling unintended breaking changes

Browse Source 
Fixes: https://github.com/nodejs/TSC/issues/1156
PR-URL: https://github.com/nodejs/node/pull/47426
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Debadree Chatterjee <debadree333@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
This commit is contained in:
Michael Dawson 2023-04-09 14:47:44 -04:00 committed by GitHub
parent 491a5c968f
commit 6c76d7eaa1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/contributing/collaborator-guide.md
View File

@ -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