Skip to content

Commit f295869

Browse files
Trottaddaleax
authored andcommitted
doc: use sentence-casing for headers in collaborator guide
The collaborator guide uses both sentence case and headline case for headings. Use sentence case to conform with our style guide. PR-URL: #34713 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Mary Marchini <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 94039b7 commit f295869

File tree

1 file changed

+38
-38
lines changed

1 file changed

+38
-38
lines changed

doc/guides/collaborator-guide.md

+38-38
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,36 @@
22

33
## Contents
44

5-
* [Issues and Pull Requests](#issues-and-pull-requests)
6-
* [Welcoming First-Time Contributors](#welcoming-first-time-contributors)
7-
* [Closing Issues and Pull Requests](#closing-issues-and-pull-requests)
5+
* [Issues and pull requests](#issues-and-pull-requests)
6+
* [Welcoming first-time contributors](#welcoming-first-time-contributors)
7+
* [Closing issues and pull requests](#closing-issues-and-pull-requests)
88
* [Author ready pull requests](#author-ready-pull-requests)
99
* [Handling own pull requests](#handling-own-pull-requests)
10-
* [Accepting Modifications](#accepting-modifications)
11-
* [Code Reviews](#code-reviews)
12-
* [Consensus Seeking](#consensus-seeking)
13-
* [Waiting for Approvals](#waiting-for-approvals)
10+
* [Accepting modifications](#accepting-modifications)
11+
* [Code reviews](#code-reviews)
12+
* [Consensus seeking](#consensus-seeking)
13+
* [Waiting for approvals](#waiting-for-approvals)
1414
* [Testing and CI](#testing-and-ci)
15-
* [Useful CI Jobs](#useful-ci-jobs)
16-
* [Starting a CI Job](#starting-a-ci-job)
17-
* [Internal vs. Public API](#internal-vs-public-api)
18-
* [Breaking Changes](#breaking-changes)
19-
* [Breaking Changes and Deprecations](#breaking-changes-and-deprecations)
20-
* [Breaking Changes to Internal Elements](#breaking-changes-to-internal-elements)
21-
* [Unintended Breaking Changes](#unintended-breaking-changes)
15+
* [Useful CI jobs](#useful-ci-jobs)
16+
* [Starting a CI job](#starting-a-ci-job)
17+
* [Internal vs. public API](#internal-vs-public-api)
18+
* [Breaking changes](#breaking-changes)
19+
* [Breaking changes and deprecations](#breaking-changes-and-deprecations)
20+
* [Breaking changes to internal elements](#breaking-changes-to-internal-elements)
21+
* [Unintended breaking changes](#unintended-breaking-changes)
2222
* [Reverting commits](#reverting-commits)
23-
* [Introducing New Modules](#introducing-new-modules)
23+
* [Introducing new modules](#introducing-new-modules)
2424
* [Additions to N-API](#additions-to-n-api)
2525
* [Deprecations](#deprecations)
2626
* [Involving the TSC](#involving-the-tsc)
27-
* [Landing Pull Requests](#landing-pull-requests)
27+
* [Landing pull requests](#landing-pull-requests)
2828
* [Using `git-node`](#using-git-node)
2929
* [Technical HOWTO](#technical-howto)
3030
* [Troubleshooting](#troubleshooting)
31-
* [I Made a Mistake](#i-made-a-mistake)
32-
* [Long Term Support](#long-term-support)
31+
* [I made a mistake](#i-made-a-mistake)
32+
* [Long term support](#long-term-support)
3333
* [What is LTS?](#what-is-lts)
34-
* [How are LTS Branches Managed?](#how-are-lts-branches-managed)
34+
* [How are LTS branches managed?](#how-are-lts-branches-managed)
3535
* [How can I help?](#how-can-i-help)
3636
* [Who to CC in the issue tracker](#who-to-cc-in-the-issue-tracker)
3737

@@ -40,13 +40,13 @@ Collaborators should understand the
4040
[guidelines for new contributors](../../CONTRIBUTING.md) and the
4141
[project governance model](../../GOVERNANCE.md).
4242

43-
## Issues and Pull Requests
43+
## Issues and pull requests
4444

4545
Mind these guidelines, the opinions of other Collaborators, and guidance of the
4646
[TSC][]. Notify other qualified parties for more input on an issue or a pull
4747
request. See [Who to CC in the issue tracker](#who-to-cc-in-the-issue-tracker).
4848

49-
### Welcoming First-Time Contributors
49+
### Welcoming first-time contributors
5050

5151
Always show courtesy to individuals submitting issues and pull requests. Be
5252
welcoming to first-time contributors, identified by the GitHub
@@ -57,7 +57,7 @@ request author. This way, once their pull request lands, GitHub will show them
5757
as a _Contributor_. Ask if they have configured their git
5858
[username][git-username] and [email][git-email] to their liking.
5959

60-
### Closing Issues and Pull Requests
60+
### Closing issues and pull requests
6161

6262
Collaborators may close any issue or pull request that is not relevant to the
6363
future of the Node.js project. Where this is unclear, leave the issue or pull
@@ -87,13 +87,13 @@ to land but is [author ready](#author-ready-pull-requests), add the
8787
`author ready` label. If you wish to land the pull request yourself, use the
8888
"assign yourself" link to self-assign it.
8989

90-
## Accepting Modifications
90+
## Accepting modifications
9191

9292
Contributors propose modifications to Node.js using GitHub pull requests. This
9393
includes modifications proposed by TSC members and other Collaborators. A pull
9494
request must pass code review and CI before landing into the codebase.
9595

96-
### Code Reviews
96+
### Code reviews
9797

9898
At least two Collaborators must approve a pull request before the pull request
9999
lands. One Collaborator approval is enough if the pull request has been open
@@ -112,7 +112,7 @@ If you are the first Collaborator to approve a pull request that has no CI yet,
112112
please [start one](#testing-and-ci). Please also start a new CI if the
113113
pull request creator pushed new code since the last CI run.
114114

115-
### Consensus Seeking
115+
### Consensus seeking
116116

117117
A pull request may land if it has the needed [approvals](#code-reviews),
118118
[CI](#testing-and-ci), [wait time](#waiting-for-approvals) and no
@@ -148,7 +148,7 @@ adding the `tsc-agenda` label to the issue.
148148
* [How to Do Code Reviews Like a Human (Part Two)](https://mtlynch.io/human-code-reviews-2/)
149149
* [Code Review Etiquette](https://css-tricks.com/code-review-etiquette/)
150150

151-
### Waiting for Approvals
151+
### Waiting for approvals
152152

153153
Before landing pull requests, allow 48 hours for input from other Collaborators.
154154
Certain types of pull requests can be fast-tracked and may land after a shorter
@@ -194,7 +194,7 @@ everything else. Start a fresh CI if more than seven days have elapsed since
194194
the original failing CI as the compiled binaries for the Windows and ARM
195195
platforms are only kept for seven days.
196196

197-
#### Useful CI Jobs
197+
#### Useful CI jobs
198198

199199
* [`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)
200200
is the CI job to test pull requests. It runs the `build-ci` and `test-ci`
@@ -219,7 +219,7 @@ not used in other CI test runs (such as tests in the `internet` or `pummel`
219219
directories). It can also make sure tests pass when provided with a flag not
220220
used in other CI test runs (such as `--worker`).
221221

222-
#### Starting a CI Job
222+
#### Starting a CI job
223223

224224
From the CI Job page, click "Build with Parameters" on the left side.
225225

@@ -244,7 +244,7 @@ Copy/paste the URL for the job into a comment in the pull request.
244244
[`node-test-pull-request`](https://ci.nodejs.org/job/node-test-pull-request/)
245245
is an exception where the GitHub bot will automatically post for you.
246246

247-
### Internal vs. Public API
247+
### Internal vs. public API
248248

249249
All functionality in the official Node.js documentation is part of the public
250250
API. Any undocumented object, property, method, argument, behavior, or event is
@@ -269,7 +269,7 @@ public. In those cases, the TSC makes a determination.
269269

270270
For undocumented APIs that are public, open a pull request documenting the API.
271271

272-
### Breaking Changes
272+
### Breaking changes
273273

274274
At least two TSC members must approve backward-incompatible changes to the
275275
master branch.
@@ -283,7 +283,7 @@ Examples of breaking changes include:
283283
* Altering expected timing of an event.
284284
* Changing the side effects of using a particular API.
285285

286-
#### Breaking Changes and Deprecations
286+
#### Breaking changes and deprecations
287287

288288
Existing stable public APIs that change in a backward-incompatible way must
289289
undergo deprecation. The exceptions to this rule are:
@@ -296,7 +296,7 @@ undergo deprecation. The exceptions to this rule are:
296296

297297
For more information, see [Deprecations](#deprecations).
298298

299-
#### Breaking Changes to Internal Elements
299+
#### Breaking changes to internal elements
300300

301301
Breaking changes to internal elements may occur in semver-patch or semver-minor
302302
commits. Take significant care when making and reviewing such changes. Make
@@ -305,7 +305,7 @@ an effort to determine the potential impact of the change in the ecosystem. Use
305305
If a change will cause ecosystem breakage, then it is semver-major. Consider
306306
providing a Public API in such cases.
307307

308-
#### Unintended Breaking Changes
308+
#### Unintended breaking changes
309309

310310
Sometimes, a change intended to be non-breaking turns out to be a breaking
311311
change. If such a change lands on the master branch, a Collaborator may revert
@@ -319,7 +319,7 @@ generated commit message will not have a subsystem and may violate line length
319319
rules. That is OK. Append the reason for the revert and any `Refs` or `Fixes`
320320
metadata. Raise a pull request like any other change.
321321

322-
### Introducing New Modules
322+
### Introducing new modules
323323

324324
Treat commits that introduce new core modules with extra care.
325325

@@ -418,7 +418,7 @@ Do this if a pull request or issue:
418418

419419
The TSC serves as the final arbiter where required.
420420

421-
## Landing Pull Requests
421+
## Landing pull requests
422422

423423
1. Avoid landing pull requests that have someone else as an assignee. Authors
424424
who wish to land their own pull requests will self-assign them. Sometimes, an
@@ -651,7 +651,7 @@ make -j4 test
651651
git push upstream master
652652
```
653653

654-
### I Made a Mistake
654+
### I made a mistake
655655

656656
* Ping a TSC member.
657657
* `#node-dev` on freenode.
@@ -665,7 +665,7 @@ git push upstream master
665665
change.
666666
* Post to `#node-dev` (IRC) if you force push.
667667

668-
### Long Term Support
668+
### Long term support
669669

670670
#### What is LTS?
671671

@@ -675,7 +675,7 @@ versions. You can find more information
675675
a branch enters LTS, the release plan limits the types of changes permitted in
676676
the branch.
677677

678-
#### How are LTS Branches Managed?
678+
#### How are LTS branches managed?
679679

680680
Each LTS release has a corresponding branch (v10.x, v8.x, etc.). Each also has a
681681
corresponding staging branch (v10.x-staging, v8.x-staging, etc.).

0 commit comments

Comments
 (0)