diff options
| author | Rich Trott <rtrott@gmail.com> | 2018-12-15 17:52:47 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2018-12-17 18:49:27 -0800 |
| commit | 3edc1c917b6f678b9146b99daf91cc478cd0e8c3 (patch) | |
| tree | a86a428bd36a2ec2c113f45947d7b9b4ecf1d3cd /COLLABORATOR_GUIDE.md | |
| parent | 19a920564585f1c223fb137408d615932609da0b (diff) | |
| download | android-node-v8-3edc1c917b6f678b9146b99daf91cc478cd0e8c3.tar.gz android-node-v8-3edc1c917b6f678b9146b99daf91cc478cd0e8c3.tar.bz2 android-node-v8-3edc1c917b6f678b9146b99daf91cc478cd0e8c3.zip | |
doc: revise "Breaking Changes" section of Collaborator Guide
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>
Diffstat (limited to 'COLLABORATOR_GUIDE.md')
| -rw-r--r-- | COLLABORATOR_GUIDE.md | 9 |
1 files changed, 2 insertions, 7 deletions
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 193591381a..2d45f25c6a 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -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 |