diff options
| author | James M Snell <jasnell@gmail.com> | 2018-03-21 12:42:25 -0700 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2018-04-02 15:03:17 -0700 |
| commit | 7238b927737d66769db8d70dea3fa6a8f2b09e0e (patch) | |
| tree | 6bfacb502645b0a99218f6fdc82310c603efd335 /COLLABORATOR_GUIDE.md | |
| parent | cd5f353405842329fc44d25d677735a8538d6c43 (diff) | |
| download | node-new-7238b927737d66769db8d70dea3fa6a8f2b09e0e.tar.gz | |
doc: deprecation clarifications
PR-URL: https://github.com/nodejs/node/pull/19522
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Diffstat (limited to 'COLLABORATOR_GUIDE.md')
| -rw-r--r-- | COLLABORATOR_GUIDE.md | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 8398643cdf..cd90d97cf9 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -408,10 +408,8 @@ recommended but not required. ### Deprecations -_Deprecation_ refers to the identification of Public APIs that should no longer -be used and that may be removed or modified in backward-incompatible ways in -a future major release of Node.js. Deprecation may be used with internal APIs if -there is expected impact on the user community. +__Deprecation__ refers to the identification of Public APIs that should no +longer be used. Node.js uses three Deprecation levels: @@ -420,9 +418,9 @@ Node.js uses three Deprecation levels: notice indicating the deprecated status is added to the API documentation but no functional changes are implemented in the code. There will be no runtime deprecation warnings emitted for such deprecations by default. - Documentation-only deprecations may trigger a runtime warning when launched - with [`--pending-deprecation`][] flag (or its alternative, - `NODE_PENDING_DEPRECATION=1` environment variable). + Documentation-only deprecations may trigger a runtime warning when Node.js + is started with the [`--pending-deprecation`][] flag or the + `NODE_PENDING_DEPRECATION=1` environment variable is set. * *Runtime Deprecation* refers to the use of process warnings emitted at runtime the first time that a deprecated API is used. A command-line @@ -432,7 +430,9 @@ Node.js uses three Deprecation levels: deprecated status. * *End-of-life* refers to APIs that have gone through Runtime Deprecation and - are ready to be removed from Node.js entirely. + are no longer subject to the semantic versioning rules used by the project. + 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 @@ -457,7 +457,9 @@ Deprecations may land in a Node.js minor release but must not be upgraded to a Runtime Deprecation until the next major release.) No API can be moved to End-of-life without first having gone through a -Runtime Deprecation cycle. +Runtime Deprecation cycle. However, there is no requirement that deprecated +code must progress ultimately to *End-of-Life*. Documentation-only and runtime +deprecations may remain indefinitely. A best effort will be made to communicate pending deprecations and associated mitigations with the ecosystem as soon as possible (preferably before the pull |