diff options
| author | Rich Trott <rtrott@gmail.com> | 2019-02-02 00:05:16 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-02-04 10:32:49 -0800 |
| commit | 3fe9267592cfef01b50f4f94eaa50b2dc495eb1a (patch) | |
| tree | fa978adbaa6a5ac33057988f5d2836ab3f77866c /COLLABORATOR_GUIDE.md | |
| parent | f395a4a401477afa38a66926b4d9c11341b12ff7 (diff) | |
| download | android-node-v8-3fe9267592cfef01b50f4f94eaa50b2dc495eb1a.tar.gz android-node-v8-3fe9267592cfef01b50f4f94eaa50b2dc495eb1a.tar.bz2 android-node-v8-3fe9267592cfef01b50f4f94eaa50b2dc495eb1a.zip | |
doc: improve doc on unintended breaking changes
Improve the material in the Collaborator Guide on unintended breaking
changes.
PR-URL: https://github.com/nodejs/node/pull/25887
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Diffstat (limited to 'COLLABORATOR_GUIDE.md')
| -rw-r--r-- | COLLABORATOR_GUIDE.md | 14 |
1 files changed, 6 insertions, 8 deletions
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 3471ab4aac..232655e5dd 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -17,7 +17,7 @@ - [Breaking Changes](#breaking-changes) - [Breaking Changes and Deprecations](#breaking-changes-and-deprecations) - [Breaking Changes to Internal Elements](#breaking-changes-to-internal-elements) - - [When Breaking Changes Actually Break Things](#when-breaking-changes-actually-break-things) + - [Unintended Breaking Changes](#unintended-breaking-changes) - [Reverting commits](#reverting-commits) - [Introducing New Modules](#introducing-new-modules) - [Additions to N-API](#additions-to-n-api) @@ -276,14 +276,12 @@ an effort to determine the potential impact of the change in the ecosystem. Use If a change will cause ecosystem breakage, then it is semver-major. Consider providing a Public API in such cases. -#### When Breaking Changes Actually Break Things +#### Unintended Breaking Changes -When any changes are landed on the master branch and it is determined that the -changes *do* break existing code, a decision may be made to revert those -changes either temporarily or permanently. However, the decision to revert or -not can often be based on many complex factors that are not easily codified. It -is also possible that the breaking commit can be labeled retroactively as a -semver-major change that will not be backported to Current or LTS branches. +Sometimes, a change intended to be non-breaking turns out to be a breaking +change. If such a change lands on the master branch, a Collaborator may revert +it. As an alternative to reverting, the TSC may apply the semver-major label +after-the-fact. ##### Reverting commits |