mirrors/nodejs
mirrors/nodejs
0
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00
Code Issues Releases Activity

doc: revise "Breaking Changes" section of Collaborator Guide

Browse Source 
Simplify material about TSC approval for breaking changes. Omit
extraneous material explaining that purely additive changes are not
breaking changes.

PR-URL: https://github.com/nodejs/node/pull/25071
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Yuta Hiroto <hello@hiroppy.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Rich Trott 2018-12-15 17:52:47 -08:00
parent 19a9205645
commit 3edc1c917b
1 changed files with 2 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
COLLABORATOR_GUIDE.md
View File

@ -242,8 +242,8 @@ For undocumented APIs that are public, open a pull request documenting the API.
### Breaking Changes
Backwards-incompatible changes may land on the master branch at any time after
sufficient review by Collaborators and approval of at least two TSC members.
At least two TSC members must approve backward-incompatible changes to the
master branch.
Examples of breaking changes include:
@ -254,11 +254,6 @@ Examples of breaking changes include:
* altering expected timing of an event
* changing the side effects of using a particular API
Purely additive changes (e.g. adding new events to `EventEmitter`
implementations, adding new arguments to a method in a way that allows
existing code to continue working without modification, or adding new
properties to an options argument) are semver-minor changes.
#### Breaking Changes and Deprecations
With a few exceptions outlined below, when backward-incompatible changes to a