Skip to content

Commit 7c8d57d

Browse files
Trotttargos
authored andcommitted
doc: revise breaking changes material in COLLABORATOR_GUIDE
* Remove unnecessary paragraph explaining why Current and LTS have stability guarantees that master branch does not. (Leave material explaining what those stability guarantees are.) * Upgrade advisory and passive "Collaborators should take significant care" to more direct "Take significant care". PR-URL: #25730 Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
1 parent d0705bd commit 7c8d57d

File tree

1 file changed

+2
-12
lines changed

1 file changed

+2
-12
lines changed

COLLABORATOR_GUIDE.md

+2-12
Original file line numberDiff line numberDiff line change
@@ -270,24 +270,14 @@ For more information, see [Deprecations](#deprecations).
270270
#### Breaking Changes to Internal Elements
271271

272272
Breaking changes to internal elements may occur in semver-patch or semver-minor
273-
commits. Collaborators should take significant care when making and reviewing
274-
such changes. An effort must be made to determine the potential impact of the
275-
change in the ecosystem. Use
273+
commits. Take significant care when making and reviewing such changes. Make
274+
an effort to determine the potential impact of the change in the ecosystem. Use
276275
[Canary in the Goldmine](https://github.com/nodejs/citgm) to test such changes.
277276
If a change will cause ecosystem breakage, then it is semver-major. Consider
278277
providing a Public API in such cases.
279278

280279
#### When Breaking Changes Actually Break Things
281280

282-
Because breaking (semver-major) changes are permitted to land on the master
283-
branch at any time, at least some subset of the user ecosystem may be adversely
284-
affected in the short term when attempting to build and use Node.js directly
285-
from the master branch. This potential instability is why Node.js offers
286-
distinct Current and LTS release streams that offer explicit stability
287-
guarantees.
288-
289-
Specifically:
290-
291281
* Breaking changes should *never* land in Current or LTS except when:
292282
* Resolving critical security issues.
293283
* Fixing a critical bug (e.g. fixing a memory leak) requires a breaking

0 commit comments

Comments
 (0)