Skip to content

Commit

Permalink
doc,meta: prefer aliases and stubs over Runtime Deprecations
Browse files Browse the repository at this point in the history
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: #29989 (comment)

PR-URL: #30153
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Franziska Hinkelmann <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
  • Loading branch information
Trott authored and targos committed Nov 11, 2019
1 parent b215b16 commit 66c6818
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions COLLABORATOR_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 66c6818

Please sign in to comment.