Skip to content

Commit 0d42470

Browse files
committed
doc: standardize on not capitalizing _collaborator_
Sometimes we capitalize _collaborator_ and sometimes not. After consulting the Microsoft Style Guide and The Chicago Manual of Style, I've concluded it is best to not capitalize it. For consistency, apply that to our various .md files. Refs: https://docs.microsoft.com/en-us/style-guide/capitalization PR-URL: nodejs#39379 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Zijian Liu <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent c12db60 commit 0d42470

File tree

6 files changed

+72
-72
lines changed

6 files changed

+72
-72
lines changed

GOVERNANCE.md

+25-25
Original file line numberDiff line numberDiff line change
@@ -28,32 +28,32 @@ See:
2828

2929
## Collaborators
3030

31-
Node.js Core Collaborators maintain the [nodejs/node][] GitHub repository.
32-
The GitHub team for Node.js Core Collaborators is @nodejs/collaborators.
31+
Node.js core collaborators maintain the [nodejs/node][] GitHub repository.
32+
The GitHub team for Node.js core collaborators is @nodejs/collaborators.
3333
Collaborators have:
3434

3535
* Commit access to the [nodejs/node][] repository
3636
* Access to the Node.js continuous integration (CI) jobs
3737

38-
Both Collaborators and non-Collaborators may propose changes to the Node.js
38+
Both collaborators and non-collaborators may propose changes to the Node.js
3939
source code. The mechanism to propose such a change is a GitHub pull request.
4040
Collaborators review and merge (_land_) pull requests.
4141

42-
Two Collaborators must approve a pull request before the pull request can land.
43-
(One Collaborator approval is enough if the pull request has been open for more
44-
than 7 days.) Approving a pull request indicates that the Collaborator accepts
45-
responsibility for the change. Approval must be from Collaborators who are not
42+
Two collaborators must approve a pull request before the pull request can land.
43+
(One collaborator approval is enough if the pull request has been open for more
44+
than 7 days.) Approving a pull request indicates that the collaborator accepts
45+
responsibility for the change. Approval must be from collaborators who are not
4646
authors of the change.
4747

48-
If a Collaborator opposes a proposed change, then the change cannot land. The
48+
If a collaborator opposes a proposed change, then the change cannot land. The
4949
exception is if the TSC votes to approve the change despite the opposition.
5050
Usually, involving the TSC is unnecessary. Often, discussions or further changes
51-
result in Collaborators removing their opposition.
51+
result in collaborators removing their opposition.
5252

5353
See:
5454

55-
* [List of Collaborators](./README.md#current-project-team-members)
56-
* [A guide for Collaborators](./doc/guides/collaborator-guide.md)
55+
* [List of collaborators](./README.md#current-project-team-members)
56+
* [A guide for collaborators](./doc/guides/collaborator-guide.md)
5757

5858
### Collaborator activities
5959

@@ -63,20 +63,20 @@ See:
6363
* Participation in working groups
6464
* Merging pull requests
6565

66-
The TSC can remove inactive Collaborators or provide them with _Emeritus_
66+
The TSC can remove inactive collaborators or provide them with _Emeritus_
6767
status. Emeriti may request that the TSC restore them to active status.
6868

6969
## Technical Steering Committee
7070

71-
A subset of the Collaborators forms the Technical Steering Committee (TSC).
71+
A subset of the collaborators forms the Technical Steering Committee (TSC).
7272
The TSC has final authority over this project, including:
7373

7474
* Technical direction
7575
* Project governance and process (including this policy)
7676
* Contribution policy
7777
* GitHub repository hosting
7878
* Conduct guidelines
79-
* Maintaining the list of Collaborators
79+
* Maintaining the list of collaborators
8080

8181
The current list of TSC members is in
8282
[the project README](./README.md#current-project-team-members).
@@ -95,7 +95,7 @@ agenda is not to review or approve all patches. Collaborators review and approve
9595
patches on GitHub.
9696

9797
Any community member can create a GitHub issue asking that the TSC review
98-
something. If consensus-seeking fails for an issue, a Collaborator may apply the
98+
something. If consensus-seeking fails for an issue, a collaborator may apply the
9999
`tsc-agenda` label. That will add it to the TSC meeting agenda.
100100

101101
Before each TSC meeting, the meeting chair will share the agenda with members of
@@ -120,11 +120,11 @@ the issue tracker is:
120120

121121
## Collaborator nominations
122122

123-
Existing Collaborators can nominate someone to become a Collaborator. Nominees
123+
Existing collaborators can nominate someone to become a collaborator. Nominees
124124
should have significant and valuable contributions across the Node.js
125125
organization.
126126

127-
To nominate a new Collaborator, open an issue in the [nodejs/node][] repository.
127+
To nominate a new collaborator, open an issue in the [nodejs/node][] repository.
128128
Provide a summary of the nominee's contributions. For example:
129129

130130
* Commits in the [nodejs/node][] repository.
@@ -144,25 +144,25 @@ Provide a summary of the nominee's contributions. For example:
144144
organization
145145
* Other participation in the wider Node.js community
146146

147-
Mention @nodejs/collaborators in the issue to notify other Collaborators about
147+
Mention @nodejs/collaborators in the issue to notify other collaborators about
148148
the nomination.
149149

150-
The nomination passes if no Collaborators oppose it after one week. Otherwise,
150+
The nomination passes if no collaborators oppose it after one week. Otherwise,
151151
the nomination fails.
152152

153153
There are steps a nominator can take in advance to make a nomination as
154-
frictionless as possible. To request feedback from other Collaborators in
155-
private, use the [Collaborators discussion page][]
156-
(which only Collaborators may view). A nominator may also work with the
154+
frictionless as possible. To request feedback from other collaborators in
155+
private, use the [collaborators discussion page][]
156+
(which only collaborators may view). A nominator may also work with the
157157
nominee to improve their contribution profile.
158158

159159
Collaborators might overlook someone with valuable contributions. In that case,
160-
the contributor may open an issue or contact a Collaborator to request a
160+
the contributor may open an issue or contact a collaborator to request a
161161
nomination.
162162

163163
### Onboarding
164164

165-
After the nomination passes, a TSC member onboards the new Collaborator. See
165+
After the nomination passes, a TSC member onboards the new collaborator. See
166166
[the onboarding guide](./onboarding.md) for details of the onboarding
167167
process.
168168

@@ -171,7 +171,7 @@ process.
171171
The TSC follows a [Consensus Seeking][] decision-making model per the
172172
[TSC Charter][].
173173

174-
[Collaborators discussion page]: https://github.com/orgs/nodejs/teams/collaborators/discussions
175174
[Consensus Seeking]: https://en.wikipedia.org/wiki/Consensus-seeking_decision-making
176175
[TSC Charter]: https://github.com/nodejs/TSC/blob/HEAD/TSC-Charter.md
176+
[collaborators discussion page]: https://github.com/orgs/nodejs/teams/collaborators/discussions
177177
[nodejs/node]: https://github.com/nodejs/node

doc/guides/collaborator-guide.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Node.js Collaborator Guide
1+
# Node.js collaborator guide
22

33
## Contents
44

@@ -36,14 +36,14 @@
3636
* [How can I help?](#how-can-i-help)
3737
* [Who to CC in the issue tracker](#who-to-cc-in-the-issue-tracker)
3838

39-
This document explains how Collaborators manage the Node.js project.
39+
This document explains how collaborators manage the Node.js project.
4040
Collaborators should understand the
4141
[guidelines for new contributors](../../CONTRIBUTING.md) and the
4242
[project governance model](../../GOVERNANCE.md).
4343

4444
## Issues and pull requests
4545

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

@@ -71,7 +71,7 @@ issues and pull requests can always be re-opened if necessary.
7171
A pull request is _author ready_ when:
7272

7373
* There is a CI run in progress or completed.
74-
* There is at least one Collaborator approval.
74+
* There is at least one collaborator approval.
7575
* There are no outstanding review comments.
7676

7777
Please always add the `author ready` label to the pull request in that case.
@@ -83,7 +83,7 @@ When you open a pull request, [start a CI](#testing-and-ci) right away. Later,
8383
after new code changes or rebasing, start a new CI.
8484

8585
As soon as the pull request is ready to land, please do so. This allows other
86-
Collaborators to focus on other pull requests. If your pull request is not ready
86+
collaborators to focus on other pull requests. If your pull request is not ready
8787
to land but is [author ready](#author-ready-pull-requests), add the
8888
`author ready` label. If you wish to land the pull request yourself, use the
8989
"assign yourself" link to self-assign it.
@@ -113,25 +113,25 @@ issues. If a user opens a security issue in the public repository:
113113
## Accepting modifications
114114

115115
Contributors propose modifications to Node.js using GitHub pull requests. This
116-
includes modifications proposed by TSC members and other Collaborators. A pull
116+
includes modifications proposed by TSC members and other collaborators. A pull
117117
request must pass code review and CI before landing into the codebase.
118118

119119
### Code reviews
120120

121-
At least two Collaborators must approve a pull request before the pull request
122-
lands. One Collaborator approval is enough if the pull request has been open
121+
At least two collaborators must approve a pull request before the pull request
122+
lands. One collaborator approval is enough if the pull request has been open
123123
for more than seven days.
124124

125-
Approving a pull request indicates that the Collaborator accepts responsibility
125+
Approving a pull request indicates that the collaborator accepts responsibility
126126
for the change.
127127

128-
Approval must be from Collaborators who are not authors of the change.
128+
Approval must be from collaborators who are not authors of the change.
129129

130130
In some cases, it might be necessary to summon a GitHub team to a pull request
131131
for review by @-mention.
132132
See [Who to CC in the issue tracker](#who-to-cc-in-the-issue-tracker).
133133

134-
If you are the first Collaborator to approve a pull request that has no CI yet,
134+
If you are the first collaborator to approve a pull request that has no CI yet,
135135
please [start one](#testing-and-ci). Please also start a new CI if the
136136
pull request creator pushed new code since the last CI run.
137137

@@ -173,7 +173,7 @@ adding the `tsc-agenda` label to the issue.
173173

174174
### Waiting for approvals
175175

176-
Before landing pull requests, allow 48 hours for input from other Collaborators.
176+
Before landing pull requests, allow 48 hours for input from other collaborators.
177177
Certain types of pull requests can be fast-tracked and can land after a shorter
178178
delay. For example:
179179

@@ -185,14 +185,14 @@ delay. For example:
185185
* Regressions that happen right before a release, or reported soon after.
186186

187187
To propose fast-tracking a pull request, apply the `fast-track` label. Then add
188-
a comment that Collaborators can upvote.
188+
a comment that collaborators can upvote.
189189

190190
If someone disagrees with the fast-tracking request, remove the label. Do not
191191
fast-track the pull request in that case.
192192

193-
The pull request can be fast-tracked if two Collaborators approve the
193+
The pull request can be fast-tracked if two collaborators approve the
194194
fast-tracking request. To land, the pull request itself still needs two
195-
Collaborator approvals and a passing CI.
195+
collaborator approvals and a passing CI.
196196

197197
Collaborators can request fast-tracking of pull requests they did not author.
198198
In that case only, the request itself is also one fast-track approval. Upvote
@@ -372,7 +372,7 @@ providing a Public API in such cases.
372372
#### Unintended breaking changes
373373

374374
Sometimes, a change intended to be non-breaking turns out to be a breaking
375-
change. If such a change lands on the master branch, a Collaborator can revert
375+
change. If such a change lands on the master branch, a collaborator can revert
376376
it. As an alternative to reverting, the TSC can apply the semver-major label
377377
after-the-fact.
378378

@@ -474,7 +474,7 @@ Do this if a pull request or issue:
474474
* Is labeled `semver-major`, or
475475
* Has a significant impact on the codebase, or
476476
* Is controversial, or
477-
* Is at an impasse among Collaborators who are participating in the discussion.
477+
* Is at an impasse among collaborators who are participating in the discussion.
478478

479479
@-mention the `@nodejs/tsc` GitHub team if you want to elevate an issue to the
480480
[TSC][]. Do not use the GitHub UI on the right-hand side to assign to
@@ -659,7 +659,7 @@ for that commit. This is an opportunity to fix commit messages.
659659
issue. A commit message can include more than one `Fixes:` lines.
660660
* Optional: One or more `Refs:` lines referencing a URL for any relevant
661661
background.
662-
* Required: A `Reviewed-By: Name <email>` line for each Collaborator who
662+
* Required: A `Reviewed-By: Name <email>` line for each collaborator who
663663
reviewed the change.
664664
* Useful for @mentions / contact list if something goes wrong in the
665665
pull request.
@@ -775,7 +775,7 @@ There are several LTS-related labels:
775775
release. For example, `land-on-v10.x` would be for a change to land in Node.js
776776
10.x.
777777

778-
Any Collaborator can attach these labels to any pull request/issue. As commits
778+
Any collaborator can attach these labels to any pull request/issue. As commits
779779
land on the staging branches, the backporter removes the `lts-watch-` label.
780780
Likewise, as commits land in an LTS release, the releaser removes the `land-on-`
781781
label.
@@ -847,7 +847,7 @@ If you cannot find who to cc for a file, `git shortlog -n -s <file>` can help.
847847

848848
* `author-ready` - A pull request is _author ready_ when:
849849
* There is a CI run in progress or completed.
850-
* There is at least one Collaborator approval (or two TSC approvals for
850+
* There is at least one collaborator approval (or two TSC approvals for
851851
semver-major pull requests).
852852
* There are no outstanding review comments.
853853

doc/guides/commit-queue.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
*tl;dr: You can land Pull Requests by adding the `commit-queue` label to it.*
66

77
Commit Queue is an experimental feature for the project which simplifies the
8-
landing process by automating it via GitHub Actions. With it, Collaborators can
8+
landing process by automating it via GitHub Actions. With it, collaborators can
99
land Pull Requests by adding the `commit-queue` label to a PR. All
1010
checks will run via node-core-utils, and if the Pull Request is ready to land,
1111
the Action will rebase it and push to master.
@@ -48,7 +48,7 @@ of the commit queue:
4848
commit that will be correctly handled by the [`--autosquash`](https://git-scm.com/docs/git-rebase#Documentation/git-rebase.txt---autosquash)
4949
option
5050
2. A CI must've ran and succeeded since the last change on the PR
51-
3. A Collaborator must have approved the PR since the last change
51+
3. A collaborator must have approved the PR since the last change
5252
4. Only Jenkins CI is checked (Actions, V8 CI and CITGM are ignored)
5353

5454
## Implementation
@@ -108,7 +108,7 @@ until all PRs have done the steps above.
108108

109109
## Reverting broken commits
110110

111-
Reverting broken commits is done manually by Collaborators, just like when
111+
Reverting broken commits is done manually by collaborators, just like when
112112
commits are landed manually via `git node land`. An easy way to revert is a
113113
good feature for the project, but is not explicitly required for the Commit
114114
Queue to work because the Action lands PRs just like collaborators do today. If

doc/guides/contributing/pull-requests.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Node.js. We cannot accept such patches.
4141

4242
In case of doubt, open an issue in the
4343
[issue tracker](https://github.com/nodejs/node/issues/) or contact one of the
44-
[project Collaborators](https://github.com/nodejs/node/#current-project-team-members).
44+
[project collaborators](https://github.com/nodejs/node/#current-project-team-members).
4545

4646
Node.js has many channels on the
4747
[OpenJS Foundation Slack](https://slack-invite.openjsf.org/). Interesting
@@ -335,7 +335,7 @@ unhelpful is likely safe to ignore.
335335
### Step 10: Landing
336336

337337
In order to land, a Pull Request needs to be reviewed and [approved][] by
338-
at least two Node.js Collaborators (one Collaborator approval is enough if the
338+
at least two Node.js collaborators (one collaborator approval is enough if the
339339
pull request has been open for more than 7 days) and pass a
340340
[CI (Continuous Integration) test run][]. After that, as long as there are no
341341
objections from other contributors, the Pull Request can be merged. If you find
@@ -391,7 +391,7 @@ change over time. The first impression you give to a new contributor never does.
391391

392392
Nits (requests for small changes that are not essential) are fine, but try to
393393
avoid stalling the Pull Request. Most nits can typically be fixed by the
394-
Node.js Collaborator landing the Pull Request but they can also be an
394+
Node.js collaborator landing the Pull Request but they can also be an
395395
opportunity for the contributor to learn a bit more about the project.
396396

397397
It is always good to clearly indicate nits when you comment: e.g.
@@ -434,7 +434,7 @@ commit.
434434

435435
### Approving a change
436436

437-
Any Node.js core Collaborator (any GitHub user with commit rights in the
437+
Any Node.js core collaborator (any GitHub user with commit rights in the
438438
`nodejs/node` repository) is authorized to approve any other contributor's
439439
work. Collaborators are not permitted to approve their own Pull Requests.
440440

@@ -503,9 +503,9 @@ feedback.
503503
All Pull Requests that contain changes to code must be run through
504504
continuous integration (CI) testing at [https://ci.nodejs.org/][].
505505

506-
Only Node.js core Collaborators with commit rights to the `nodejs/node`
506+
Only Node.js core collaborators with commit rights to the `nodejs/node`
507507
repository may start a CI testing run. The specific details of how to do
508-
this are included in the new Collaborator [Onboarding guide][].
508+
this are included in the new collaborator [Onboarding guide][].
509509

510510
Ideally, the code change will pass ("be green") on all platform configurations
511511
supported by Node.js (there are over 30 platform configurations currently).
@@ -551,9 +551,9 @@ Every Pull Request needs to be tested
551551
to make sure that it works on the platforms that Node.js
552552
supports. This is done by running the code through the CI system.
553553

554-
Only a Collaborator can start a CI run. Usually one of them will do it
554+
Only a collaborator can start a CI run. Usually one of them will do it
555555
for you as approvals for the Pull Request come in.
556-
If not, you can ask a Collaborator to start a CI run.
556+
If not, you can ask a collaborator to start a CI run.
557557

558558
### Waiting until the pull request gets landed
559559

@@ -567,7 +567,7 @@ widely used, so don't be discouraged!
567567
### Check out the collaborator guide
568568

569569
If you want to know more about the code review and the landing process, see the
570-
[Collaborator Guide][].
570+
[collaborator guide][].
571571

572572
### Appendix: subsystems
573573

@@ -583,10 +583,10 @@ More than one subsystem may be valid for any particular issue or pull request.
583583
[Building guide]: ../../../BUILDING.md
584584
[CI (Continuous Integration) test run]: #ci-testing
585585
[Code of Conduct]: https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md
586-
[Collaborator Guide]: ../collaborator-guide.md
587586
[Onboarding guide]: ../../../onboarding.md
588587
[approved]: #getting-approvals-for-your-pull-request
589588
[benchmark results]: ../writing-and-running-benchmarks.md
589+
[collaborator guide]: ../collaborator-guide.md
590590
[guide for writing tests in Node.js]: ../writing-tests.md
591591
[hiding-a-comment]: https://help.github.com/articles/managing-disruptive-comments/#hiding-a-comment
592592
[https://ci.nodejs.org/]: https://ci.nodejs.org/

0 commit comments

Comments
 (0)