Skip to content

Commit 966a2df

Browse files
committed
doc: revise "Breaking Changes and Deprecations"
Revise the "Breaking Changes and Deprecations" section of the Collaborator Guide. Simplify the text. Remove redundant text. The "Deprecations" section is thorough and linked to from this section. PR-URL: nodejs#25116 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
1 parent 845fdd0 commit 966a2df

File tree

1 file changed

+6
-23
lines changed

1 file changed

+6
-23
lines changed

COLLABORATOR_GUIDE.md

+6-23
Original file line numberDiff line numberDiff line change
@@ -256,31 +256,14 @@ Examples of breaking changes include:
256256

257257
#### Breaking Changes and Deprecations
258258

259-
With a few exceptions outlined below, when backward-incompatible changes to a
260-
*Public* API are necessary, the existing API *must* be deprecated *first* and
261-
the new API either introduced in parallel or added after the next major Node.js
262-
version following the deprecation as a replacement for the deprecated API. In
263-
other words, as a general rule, existing *Public* APIs *must not* change (in a
264-
backward-incompatible way) without a deprecation.
259+
Existing stable public APIs that change in a backward-incompatible way must
260+
undergo deprecation. The exceptions to this rule are:
265261

266-
Exceptions to this rule may be made in the following cases:
267-
268-
* Adding or removing errors thrown or reported by a Public API;
262+
* Adding or removing errors thrown or reported by a public API;
269263
* Changing error messages for errors without error code;
270-
* Altering the timing and non-internal side effects of the Public API.
271-
272-
Such changes *must* be handled as semver-major changes but MAY be landed
273-
without a [Deprecation cycle](#deprecation-cycle).
274-
275-
Note that errors thrown, along with behaviors and APIs implemented by
276-
dependencies of Node.js (e.g. those originating from V8) are generally not
277-
under the control of Node.js and therefore *are not directly subject to this
278-
policy*. However, care should still be taken when landing updates to
279-
dependencies when it is known or expected that breaking changes to error
280-
handling may have been made. Additional CI testing may be required.
281-
282-
From time-to-time, in particularly exceptional cases, the TSC may be asked to
283-
consider and approve additional exceptions to this rule.
264+
* Altering the timing and non-internal side effects of the public API;
265+
* Changes to errors thrown by dependencies of Node.js, such as V8;
266+
* One-time exceptions granted by the TSC.
284267

285268
For more information, see [Deprecations](#deprecations).
286269

0 commit comments

Comments
 (0)