1
- # Node.js Collaborator Guide
1
+ # Node.js collaborator guide
2
2
3
3
## Contents
4
4
36
36
* [ How can I help?] ( #how-can-i-help )
37
37
* [ Who to CC in the issue tracker] ( #who-to-cc-in-the-issue-tracker )
38
38
39
- This document explains how Collaborators manage the Node.js project.
39
+ This document explains how collaborators manage the Node.js project.
40
40
Collaborators should understand the
41
41
[ guidelines for new contributors] ( ../../CONTRIBUTING.md ) and the
42
42
[ project governance model] ( ../../GOVERNANCE.md ) .
43
43
44
44
## Issues and pull requests
45
45
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
47
47
[ TSC] [ ] . Notify other qualified parties for more input on an issue or a pull
48
48
request. See [ Who to CC in the issue tracker] ( #who-to-cc-in-the-issue-tracker ) .
49
49
@@ -71,7 +71,7 @@ issues and pull requests can always be re-opened if necessary.
71
71
A pull request is _ author ready_ when:
72
72
73
73
* 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.
75
75
* There are no outstanding review comments.
76
76
77
77
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,
83
83
after new code changes or rebasing, start a new CI.
84
84
85
85
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
87
87
to land but is [ author ready] ( #author-ready-pull-requests ) , add the
88
88
` author ready ` label. If you wish to land the pull request yourself, use the
89
89
"assign yourself" link to self-assign it.
@@ -113,25 +113,25 @@ issues. If a user opens a security issue in the public repository:
113
113
## Accepting modifications
114
114
115
115
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
117
117
request must pass code review and CI before landing into the codebase.
118
118
119
119
### Code reviews
120
120
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
123
123
for more than seven days.
124
124
125
- Approving a pull request indicates that the Collaborator accepts responsibility
125
+ Approving a pull request indicates that the collaborator accepts responsibility
126
126
for the change.
127
127
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.
129
129
130
130
In some cases, it might be necessary to summon a GitHub team to a pull request
131
131
for review by @-mention.
132
132
See [ Who to CC in the issue tracker] ( #who-to-cc-in-the-issue-tracker ) .
133
133
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,
135
135
please [ start one] ( #testing-and-ci ) . Please also start a new CI if the
136
136
pull request creator pushed new code since the last CI run.
137
137
@@ -173,7 +173,7 @@ adding the `tsc-agenda` label to the issue.
173
173
174
174
### Waiting for approvals
175
175
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 .
177
177
Certain types of pull requests can be fast-tracked and can land after a shorter
178
178
delay. For example:
179
179
@@ -185,14 +185,14 @@ delay. For example:
185
185
* Regressions that happen right before a release, or reported soon after.
186
186
187
187
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.
189
189
190
190
If someone disagrees with the fast-tracking request, remove the label. Do not
191
191
fast-track the pull request in that case.
192
192
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
194
194
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.
196
196
197
197
Collaborators can request fast-tracking of pull requests they did not author.
198
198
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.
372
372
#### Unintended breaking changes
373
373
374
374
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
376
376
it. As an alternative to reverting, the TSC can apply the semver-major label
377
377
after-the-fact.
378
378
@@ -474,7 +474,7 @@ Do this if a pull request or issue:
474
474
* Is labeled ` semver-major ` , or
475
475
* Has a significant impact on the codebase, or
476
476
* 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.
478
478
479
479
@-mention the ` @nodejs/tsc ` GitHub team if you want to elevate an issue to the
480
480
[ 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.
659
659
issue. A commit message can include more than one ` Fixes: ` lines.
660
660
* Optional: One or more ` Refs: ` lines referencing a URL for any relevant
661
661
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
663
663
reviewed the change.
664
664
* Useful for @mentions / contact list if something goes wrong in the
665
665
pull request.
@@ -775,7 +775,7 @@ There are several LTS-related labels:
775
775
release. For example, ` land-on-v10.x ` would be for a change to land in Node.js
776
776
10.x.
777
777
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
779
779
land on the staging branches, the backporter removes the ` lts-watch- ` label.
780
780
Likewise, as commits land in an LTS release, the releaser removes the ` land-on- `
781
781
label.
@@ -847,7 +847,7 @@ If you cannot find who to cc for a file, `git shortlog -n -s <file>` can help.
847
847
848
848
* ` author-ready ` - A pull request is _ author ready_ when:
849
849
* 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
851
851
semver-major pull requests).
852
852
* There are no outstanding review comments.
853
853
0 commit comments