diff options
| author | Rich Trott <rtrott@gmail.com> | 2017-12-06 21:07:09 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2017-12-08 11:29:47 -0800 |
| commit | 5b4a5c82567da30156452151bc4627a7fc79d81a (patch) | |
| tree | f789802e3afba907f6a3158d9c8b3814bcac009e /COLLABORATOR_GUIDE.md | |
| parent | b681d8d1a1400847780a6d2b07bbb879fb72a812 (diff) | |
| download | android-node-v8-5b4a5c82567da30156452151bc4627a7fc79d81a.tar.gz android-node-v8-5b4a5c82567da30156452151bc4627a7fc79d81a.tar.bz2 android-node-v8-5b4a5c82567da30156452151bc4627a7fc79d81a.zip | |
doc: improve readability of COLLABORATOR_GUIDE.md
* convert run-on sentence to a bulleted list
* standardize capitalization in "Collaborators"
PR-URL: https://github.com/nodejs/node/pull/17519
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'COLLABORATOR_GUIDE.md')
| -rw-r--r-- | COLLABORATOR_GUIDE.md | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 10a4803023..9a4b5184b3 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -130,7 +130,7 @@ can be fast-tracked and may be landed after a shorter delay: * Changes that fix regressions. When a pull request is deemed suitable to be fast-tracked, label it with -`fast-track`. The pull request can be landed once 2 or more collaborators +`fast-track`. The pull request can be landed once 2 or more Collaborators approve both the pull request and the fast-tracking request, and the necessary CI testing is done. @@ -225,15 +225,16 @@ on how to handle those types of changes. ### 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. - -Examples of breaking changes include, but are not necessarily limited to, -removal or redefinition of existing API arguments, changing return values -(except when return values do not currently exist), removing or modifying -existing properties on an options argument, adding or removing errors, -changing error messages in any way, altering expected timing of an event (e.g. -moving from sync to async responses or vice versa), and changing the -non-internal side effects of using a particular API. +sufficient review by Collaborators and approval of at least two TSC members. + +Examples of breaking changes include: + +* removal or redefinition of existing API arguments +* changing return values +* removing or modifying existing properties on an options argument +* adding or removing errors +* 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 |