Skip to content

Commit cc4ae20

Browse files
Trottaddaleax
authored andcommitted
doc: improve doc on unintended breaking changes
Improve the material in the Collaborator Guide on unintended breaking changes. PR-URL: #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>
1 parent 8b71464 commit cc4ae20

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

COLLABORATOR_GUIDE.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
- [Breaking Changes](#breaking-changes)
1818
- [Breaking Changes and Deprecations](#breaking-changes-and-deprecations)
1919
- [Breaking Changes to Internal Elements](#breaking-changes-to-internal-elements)
20-
- [When Breaking Changes Actually Break Things](#when-breaking-changes-actually-break-things)
20+
- [Unintended Breaking Changes](#unintended-breaking-changes)
2121
- [Reverting commits](#reverting-commits)
2222
- [Introducing New Modules](#introducing-new-modules)
2323
- [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
276276
If a change will cause ecosystem breakage, then it is semver-major. Consider
277277
providing a Public API in such cases.
278278

279-
#### When Breaking Changes Actually Break Things
279+
#### Unintended Breaking Changes
280280

281-
When any changes are landed on the master branch and it is determined that the
282-
changes *do* break existing code, a decision may be made to revert those
283-
changes either temporarily or permanently. However, the decision to revert or
284-
not can often be based on many complex factors that are not easily codified. It
285-
is also possible that the breaking commit can be labeled retroactively as a
286-
semver-major change that will not be backported to Current or LTS branches.
281+
Sometimes, a change intended to be non-breaking turns out to be a breaking
282+
change. If such a change lands on the master branch, a Collaborator may revert
283+
it. As an alternative to reverting, the TSC may apply the semver-major label
284+
after-the-fact.
287285

288286
##### Reverting commits
289287

0 commit comments

Comments
 (0)