diff options
| author | Rich Trott <rtrott@gmail.com> | 2018-12-22 19:49:31 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2018-12-26 08:13:40 -0800 |
| commit | ab76eac3016db9d84cea045e9ab1be89ed35cb60 (patch) | |
| tree | 882acbfdd9f77de575ac83bf90f43eae2e6ce4fb /COLLABORATOR_GUIDE.md | |
| parent | 09519953ea1285e4d756e2dcdadaa77d6bc03245 (diff) | |
| download | android-node-v8-ab76eac3016db9d84cea045e9ab1be89ed35cb60.tar.gz android-node-v8-ab76eac3016db9d84cea045e9ab1be89ed35cb60.tar.bz2 android-node-v8-ab76eac3016db9d84cea045e9ab1be89ed35cb60.zip | |
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: https://github.com/nodejs/node/pull/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>
Diffstat (limited to 'COLLABORATOR_GUIDE.md')
| -rw-r--r-- | COLLABORATOR_GUIDE.md | 21 |
1 files changed, 7 insertions, 14 deletions
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 71cb741e98..c3805d4a2c 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -269,20 +269,13 @@ For more information, see [Deprecations](#deprecations). #### Breaking Changes to Internal Elements -Breaking changes to internal elements are permitted in semver-patch or -semver-minor commits but Collaborators should take significant care when -making and reviewing such changes. Before landing such commits, an effort -must be made to determine the potential impact of the change in the ecosystem -by analyzing current use and by validating such changes through ecosystem -testing using the [Canary in the Goldmine](https://github.com/nodejs/citgm) -tool. If a change cannot be made without ecosystem breakage, then TSC review is -required before landing the change as anything less than semver-major. - -If a determination is made that a particular internal API (for instance, an -underscore `_` prefixed property) is sufficiently relied upon by the ecosystem -such that any changes may break user code, then serious consideration should be -given to providing an alternative Public API for that functionality before any -breaking changes are made. +Breaking changes to internal elements may occur in semver-patch or semver-minor +commits. Collaborators should take significant care when making and reviewing +such changes. An effort must be made to determine the potential impact of the +change in the ecosystem. Use +[Canary in the Goldmine](https://github.com/nodejs/citgm) to test such changes. +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 |