diff options
| author | Rich Trott <rtrott@gmail.com> | 2019-02-20 22:30:14 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-02-27 23:42:35 -0800 |
| commit | 04d5c1b8fde631e82b4b3d025e5532e8d05add39 (patch) | |
| tree | db17f315bc64122e0607e9765e6be1828e8a9e43 /COLLABORATOR_GUIDE.md | |
| parent | 4a3928e125bb1ab7242e8134f911b6c71551bd75 (diff) | |
| download | android-node-v8-04d5c1b8fde631e82b4b3d025e5532e8d05add39.tar.gz android-node-v8-04d5c1b8fde631e82b4b3d025e5532e8d05add39.tar.bz2 android-node-v8-04d5c1b8fde631e82b4b3d025e5532e8d05add39.zip | |
doc: revise deprecation semverness info in Collaborator Guide
Simplify and clarify deprecation semverness information in the
Collaborator Guide. Unlike some of the other changes I've made lately,
this one is not merely cosmetic. It changes information about how to
handle deprecations vis-a-vis SemVer. The revised conventions take
advange of `notable change` labels etc. instead of suggesting that
doc-deprecations be treated as `semver-minor`. The idea that a
deprecation is a new feature seems incorrect from a SemVer perspective,
but probably made sense at the time the text was written if we weren't
yet using `notable change` etc.
PR-URL: https://github.com/nodejs/node/pull/26232
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'COLLABORATOR_GUIDE.md')
| -rw-r--r-- | COLLABORATOR_GUIDE.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index f74bc7eda9..9456d64c64 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -339,13 +339,13 @@ documentation must state the deprecation status. * Backward-incompatible changes including complete removal of such APIs may occur at any time. -Documentation-Only Deprecations may be handled as semver-minor or semver-major -changes. Such deprecations have no impact on the successful operation of running -code and therefore should not be viewed as breaking changes. +Apply the `notable change` label to all pull requests that introduce +Documentation-Only Deprecations. Such deprecations have no impact on code +execution. Thus, they are not breaking changes (`semver-major`). -Runtime Deprecations and End-of-life APIs (internal or public) must be -handled as semver-major changes unless there is TSC consensus to land the -deprecation as a semver-minor. +Runtime Deprecations and End-of-life APIs (internal or public) are breaking +changes (`semver-major`). The TSC may make exceptions, deciding that one of +these deprecations is not a breaking change. All Documentation-Only and Runtime deprecations will be assigned a unique identifier that can be used to persistently refer to the deprecation in |