From 66c68184736b7577fb4f32c0bd8bdc7de51debec Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 28 Oct 2019 05:46:08 -0700 Subject: [PATCH] doc,meta: prefer aliases and stubs over Runtime Deprecations MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-By: Michaël Zasso Reviewed-By: Colin Ihrig Reviewed-By: Franziska Hinkelmann Reviewed-By: Trivikram Kamat Reviewed-By: Luigi Pinca Reviewed-By: Gireesh Punathil Reviewed-By: Michael Dawson --- COLLABORATOR_GUIDE.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 43bd683e800287..0315a2dbb83001 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