Skip to content

Commit 0948238

Browse files
TrottMylesBorins
authored andcommitted
doc: improve readability of COLLABORATOR_GUIDE.md
* convert run-on sentence to a bulleted list * standardize capitalization in "Collaborators" PR-URL: #17519 Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Anatoli Papirovski <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 1aae28b commit 0948238

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

COLLABORATOR_GUIDE.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ can be fast-tracked and may be landed after a shorter delay:
130130
* Changes that fix regressions.
131131

132132
When a pull request is deemed suitable to be fast-tracked, label it with
133-
`fast-track`. The pull request can be landed once 2 or more collaborators
133+
`fast-track`. The pull request can be landed once 2 or more Collaborators
134134
approve both the pull request and the fast-tracking request, and the necessary
135135
CI testing is done.
136136

@@ -225,15 +225,16 @@ on how to handle those types of changes.
225225
### Breaking Changes
226226

227227
Backwards-incompatible changes may land on the master branch at any time after
228-
sufficient review by collaborators and approval of at least two TSC members.
229-
230-
Examples of breaking changes include, but are not necessarily limited to,
231-
removal or redefinition of existing API arguments, changing return values
232-
(except when return values do not currently exist), removing or modifying
233-
existing properties on an options argument, adding or removing errors,
234-
changing error messages in any way, altering expected timing of an event (e.g.
235-
moving from sync to async responses or vice versa), and changing the
236-
non-internal side effects of using a particular API.
228+
sufficient review by Collaborators and approval of at least two TSC members.
229+
230+
Examples of breaking changes include:
231+
232+
* removal or redefinition of existing API arguments
233+
* changing return values
234+
* removing or modifying existing properties on an options argument
235+
* adding or removing errors
236+
* altering expected timing of an event
237+
* changing the side effects of using a particular API
237238

238239
Purely additive changes (e.g. adding new events to `EventEmitter`
239240
implementations, adding new arguments to a method in a way that allows

0 commit comments

Comments
 (0)