diff options
| author | Rich Trott <rtrott@gmail.com> | 2019-10-28 05:46:08 -0700 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-10-30 06:46:34 -0700 |
| commit | 8fa4abdf23abb09bd19dfb9a358a70d90672231e (patch) | |
| tree | 0424e2c4a59692d2b9261e0e63a44e56e0e72f3a /COLLABORATOR_GUIDE.md | |
| parent | 050a3b1d7531b9c4e37aaa334ced363e77e52759 (diff) | |
| download | node-new-8fa4abdf23abb09bd19dfb9a358a70d90672231e.tar.gz | |
doc,meta: prefer aliases and stubs over Runtime Deprecations
Avoid Runtime Deprecations when an alias or a stub/no-op will suffice.
An alias or stub will have lower maintenance costs for end users.
Refs: https://github.com/nodejs/node/pull/29989#issuecomment-545427805
PR-URL: https://github.com/nodejs/node/pull/30153
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Diffstat (limited to 'COLLABORATOR_GUIDE.md')
| -rw-r--r-- | COLLABORATOR_GUIDE.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 43bd683e80..0315a2dbb8 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -341,6 +341,9 @@ 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. +Avoid Runtime Deprecations when an alias or a stub/no-op will suffice. An alias +or stub will have lower maintenance costs for end users and Node.js core. + All deprecations receive a unique and immutable identifier. Documentation, warnings, and errors use the identifier when referring to the deprecation. The documentation for the deprecation identifier must always remain in the API |