Skip to content

Commit 3902be8

Browse files
mhdawsonMoLow
authored andcommittedJul 6, 2023
doc: info on handling unintended breaking changes
Fixes: nodejs/TSC#1156 PR-URL: #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>
1 parent 1271b0e commit 3902be8

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed
 

‎doc/contributing/collaborator-guide.md

+18
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,24 @@ change. If such a change lands on the `main` branch, a collaborator can revert
381381
it. As an alternative to reverting, the TSC can apply the semver-major label
382382
after-the-fact.
383383

384+
If the change has already been backported to release lines open
385+
an issue in the TSC repository to discuss how best to proceed. In the past
386+
we have often reverted in the release lines and kept the change on main. The
387+
decision to revert or not most often is based on limiting the impact
388+
to the ecosystem and how quickly the breaking change is discovered.
389+
390+
If the change is reverted make sure to:
391+
392+
* consider if additional tests can be added to avoid a similar breaking change
393+
being missed in the future.
394+
* consider if adding packages to CITGM would have helped catch
395+
the breaking change.
396+
* ensure the changelog with the revert clearly explains the situation and
397+
it's impact on those who may have already used the updated API.
398+
399+
In either case make sure that the documentation and changelog for the
400+
original breaking change are updated to reflect the breaking behavior.
401+
384402
##### Reverting commits
385403

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

0 commit comments

Comments
 (0)
Please sign in to comment.