From 6d93ab3bd29d017043099353edee1d914c92ebc9 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 5 Apr 2023 15:04:42 -0400 Subject: [PATCH 1/2] doc: info on handling unintended breaking changes Fixes: https://github.com/nodejs/TSC/issues/1156 --- doc/contributing/collaborator-guide.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/contributing/collaborator-guide.md b/doc/contributing/collaborator-guide.md index 14963263c5546a..62980477c8f90c 100644 --- a/doc/contributing/collaborator-guide.md +++ b/doc/contributing/collaborator-guide.md @@ -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 udpated 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 ` or `git revert ..`. The From 4410a2875487061416f7c7794a8e5b61b07d7b83 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Thu, 6 Apr 2023 11:14:25 -0400 Subject: [PATCH 2/2] Update doc/contributing/collaborator-guide.md Co-authored-by: Mohammed Keyvanzadeh --- doc/contributing/collaborator-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing/collaborator-guide.md b/doc/contributing/collaborator-guide.md index 62980477c8f90c..532ecb43ca9ef5 100644 --- a/doc/contributing/collaborator-guide.md +++ b/doc/contributing/collaborator-guide.md @@ -394,7 +394,7 @@ If the change is reverted make sure to: * 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 udpated API. + 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.