Skip to content

Commit a702fcb

Browse files
TrottMylesBorins
authored andcommitted
doc: copy-edit COLLABORATOR_GUIDE.md
Apply various style and punctuation fixes. PR-URL: #17922 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 240121e commit a702fcb

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

COLLABORATOR_GUIDE.md

+16-17
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
- [How is an LTS release cut?](#how-is-an-lts-release-cut)
3434

3535
This document contains information for Collaborators of the Node.js
36-
project regarding maintaining the code, documentation, and issues.
36+
project regarding managing the project's code, documentation, and issue tracker.
3737

3838
Collaborators should be familiar with the guidelines for new
3939
contributors in [CONTRIBUTING.md](./CONTRIBUTING.md) and also
@@ -206,11 +206,10 @@ Node.js API are internal:
206206
- Any native C/C++ APIs/ABIs exported by the Node.js `*.h` header files that
207207
are hidden behind the `NODE_WANT_INTERNALS` flag are internal.
208208

209-
Exception to each of these points can be made if use or behavior of a given
210-
internal API can be demonstrated to be sufficiently relied upon by the Node.js
211-
ecosystem such that any changes would cause too much breakage. The threshold
212-
for what qualifies as too much breakage is to be decided on a case-by-case
213-
basis by the TSC.
209+
Exceptions can be made if use or behavior of a given internal API can be
210+
demonstrated to be sufficiently relied upon by the Node.js ecosystem such that
211+
any changes would cause too much breakage. The threshold for what qualifies as
212+
too much breakage is to be decided on a case-by-case basis by the TSC.
214213

215214
If it is determined that a currently undocumented object, property, method,
216215
argument, or event *should* be documented, then a pull request adding the
@@ -249,14 +248,14 @@ properties to an options argument) are semver-minor changes.
249248

250249
#### Breaking Changes and Deprecations
251250

252-
With a few notable exceptions outlined below, when backwards incompatible
253-
changes to a *Public* API are necessary, the existing API *must* be deprecated
254-
*first* and the new API either introduced in parallel or added after the next
255-
major Node.js version following the deprecation as a replacement for the
256-
deprecated API. In other words, as a general rule, existing *Public* APIs
257-
*must not* change (in a backwards incompatible way) without a deprecation.
251+
With a few exceptions outlined below, when backward-incompatible changes to a
252+
*Public* API are necessary, the existing API *must* be deprecated *first* and
253+
the new API either introduced in parallel or added after the next major Node.js
254+
version following the deprecation as a replacement for the deprecated API. In
255+
other words, as a general rule, existing *Public* APIs *must not* change (in a
256+
backward-incompatible way) without a deprecation.
258257

259-
Exception to this rule is given in the following cases:
258+
Exceptions to this rule may be made in the following cases:
260259

261260
* Adding or removing errors thrown or reported by a Public API;
262261
* Changing error messages;
@@ -357,7 +356,7 @@ recommended but not required.
357356
### Deprecations
358357

359358
_Deprecation_ refers to the identification of Public APIs that should no longer
360-
be used and that may be removed or modified in non-backwards compatible ways in
359+
be used and that may be removed or modified in backward-incompatible ways in
361360
a future major release of Node.js. Deprecation may be used with internal APIs if
362361
there is expected impact on the user community.
363362

@@ -497,7 +496,7 @@ Check and re-review the changes:
497496
$ git diff upstream/master
498497
```
499498

500-
Check number of commits and commit messages:
499+
Check the number of commits and commit messages:
501500

502501
```text
503502
$ git log upstream/master...master
@@ -658,7 +657,7 @@ commit final.
658657
#### What is LTS?
659658

660659
Long Term Support (often referred to as *LTS*) guarantees application developers
661-
a 30 month support cycle with specific versions of Node.js.
660+
a 30-month support cycle with specific versions of Node.js.
662661

663662
You can find more information
664663
[in the full release plan](https://github.com/nodejs/Release#release-plan).
@@ -671,7 +670,7 @@ certain performance improvements that can be demonstrated to not break existing
671670
applications. Semver-minor changes are only permitted if required for bug fixes
672671
and then only on a case-by-case basis with LTS WG and possibly Technical
673672
Steering Committee (TSC) review. Semver-major changes are permitted only if
674-
required for security related fixes.
673+
required for security-related fixes.
675674

676675
Once a Current branch moves into Maintenance mode, only **critical** bugs,
677676
**critical** security fixes, and documentation updates will be permitted.

0 commit comments

Comments
 (0)