Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 39b3fd1

Browse filesBrowse files
Trotttargos
authored andcommitted
doc: revise "Breaking Changes to Internal Elements"
Revise the "Breaking Changes to Internal Elements" section of COLLABORATOR_GUIDE.md. Simplify wording, shorten sentences, and remove redundant material. PR-URL: #25190 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
1 parent 73ccfc8 commit 39b3fd1
Copy full SHA for 39b3fd1

File tree

Expand file treeCollapse file tree

1 file changed

+7
-14
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+7
-14
lines changed
Open diff view settings
Collapse file

‎COLLABORATOR_GUIDE.md‎

Copy file name to clipboardExpand all lines: COLLABORATOR_GUIDE.md
+7-14Lines changed: 7 additions & 14 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -269,20 +269,13 @@ For more information, see [Deprecations](#deprecations).
269269

270270
#### Breaking Changes to Internal Elements
271271

272-
Breaking changes to internal elements are permitted in semver-patch or
273-
semver-minor commits but Collaborators should take significant care when
274-
making and reviewing such changes. Before landing such commits, an effort
275-
must be made to determine the potential impact of the change in the ecosystem
276-
by analyzing current use and by validating such changes through ecosystem
277-
testing using the [Canary in the Goldmine](https://github.com/nodejs/citgm)
278-
tool. If a change cannot be made without ecosystem breakage, then TSC review is
279-
required before landing the change as anything less than semver-major.
280-
281-
If a determination is made that a particular internal API (for instance, an
282-
underscore `_` prefixed property) is sufficiently relied upon by the ecosystem
283-
such that any changes may break user code, then serious consideration should be
284-
given to providing an alternative Public API for that functionality before any
285-
breaking changes are made.
272+
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
276+
[Canary in the Goldmine](https://github.com/nodejs/citgm) to test such changes.
277+
If a change will cause ecosystem breakage, then it is semver-major. Consider
278+
providing a Public API in such cases.
286279

287280
#### When Breaking Changes Actually Break Things
288281

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.