Commit 39b3fd1
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
1 file changed
Lines changed: 7 additions & 14 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -269,20 +269,13 @@ For more information, see [Deprecations](#deprecations). | |||
| 269 | 269 | ||
| 270 | 270 | #### Breaking Changes to Internal Elements | |
| 271 | 271 | ||
| 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. | ||
| 286 | 279 | ||
| 287 | 280 | #### When Breaking Changes Actually Break Things | |
| 288 | 281 | ||
0 commit comments