@@ -28,23 +28,23 @@ onboarding session.
28
28
* [ local setup] ( #local-setup )
29
29
* [ project goals and values] ( #project-goals-and-values )
30
30
* [ managing the issue tracker] ( #managing-the-issue-tracker )
31
- * [ reviewing PRs ] ( #reviewing-prs )
32
- * [ landing PRs ] ( #landing-prs )
31
+ * [ reviewing pull requests ] ( #reviewing-pull-requests )
32
+ * [ landing pull requests ] ( #landing-pull-requests )
33
33
34
34
## Local setup
35
35
36
36
* git:
37
37
* Make sure you have whitespace=fix: `git config --global --add
38
38
apply.whitespace fix`
39
- * Always continue to PR from your own GitHub fork
39
+ * Always create a branch in your own GitHub fork for pull requests
40
40
* Branches in the ` nodejs/node ` repository are only for release lines
41
41
* Add the canonical nodejs repository as ` upstream ` remote:
42
42
* ` git remote add upstream git://github.com/nodejs/node.git `
43
43
* To update from ` upstream ` :
44
44
* ` git checkout master `
45
45
* ` git remote update -p ` OR ` git fetch --all `
46
46
* ` git merge --ff-only upstream/master ` (or ` REMOTENAME/BRANCH ` )
47
- * Make a new branch for each PR you submit.
47
+ * Make a new branch for each pull request you submit.
48
48
* Membership: Consider making your membership in the Node.js GitHub
49
49
organization public. This makes it easier to identify collaborators.
50
50
Instructions on how to do that are available at
@@ -77,9 +77,9 @@ The project has two venues for real-time discussion:
77
77
## Managing the issue tracker
78
78
79
79
* You have (mostly) free rein; don't hesitate to close an issue if you are
80
- confident that it should be closed
81
- * Be nice about closing issues! Let people know why, and that issues and PRs
82
- can be reopened if necessary
80
+ confident that it should be closed.
81
+ * Be nice about closing issues! Let people know why, and that issues and pull
82
+ requests can be reopened if necessary.
83
83
84
84
* See [ Labels] [ ] .
85
85
* There is [ a bot] ( https://github.com/nodejs-github-bot/github-bot ) that
@@ -92,7 +92,7 @@ The project has two venues for real-time discussion:
92
92
` semver-major ` label
93
93
* When adding a ` semver-* ` label, add a comment explaining why you're adding
94
94
it. Do it right away so you don't forget!
95
- * Please add the [ ` author-ready ` ] [ ] label for PRs , if applicable.
95
+ * Please add the [ ` author-ready ` ] [ ] label for pull requests , if applicable.
96
96
97
97
* See [ Who to CC in the issue tracker] [ who-to-cc ] .
98
98
* This will come more naturally over time
@@ -110,7 +110,7 @@ The project has two venues for real-time discussion:
110
110
* You can find the full moderation policy
111
111
[ here] ( https://github.com/nodejs/admin/blob/HEAD/Moderation-Policy.md ) .
112
112
113
- ## Reviewing PRs
113
+ ## Reviewing pull requests
114
114
115
115
* The primary goal is for the codebase to improve.
116
116
* Secondary (but not far off) is for the person submitting code to succeed. A
@@ -147,7 +147,7 @@ The project has two venues for real-time discussion:
147
147
* If you see that the requested changes have been made, you can clear
148
148
another collaborator's ` Changes requested ` review.
149
149
* Use ` Changes requested ` to indicate that you are considering some of your
150
- comments to block the PR from landing.
150
+ comments to block the pull request from landing.
151
151
152
152
* What belongs in Node.js:
153
153
* Opinions vary – it’s good to have a broad collaborator base for that reason!
@@ -182,17 +182,17 @@ The project has two venues for real-time discussion:
182
182
* Use the [ Build WG repository] ( https://github.com/nodejs/build ) to file
183
183
issues for the Build WG members who maintain the CI infrastructure.
184
184
185
- ## Landing PRs
185
+ ## Landing pull requests
186
186
187
187
See the Collaborator Guide: [ Landing pull requests] [ ] .
188
188
189
- Commits in one PR that belong to one logical change should
189
+ Commits in one pull request that belong to one logical change should
190
190
be squashed. It is rarely the case in onboarding exercises, so this
191
191
needs to be pointed out separately during the onboarding.
192
192
193
193
<!-- TODO(joyeechueng): provide examples about "one logical change" -->
194
194
195
- ## Exercise: Make a PR adding yourself to the README
195
+ ## Exercise: Make a pull request adding yourself to the README
196
196
197
197
* Example:
198
198
< https://github.com/nodejs/node/commit/b58fe52692659c0bc25ddbe6afa7f4ae2c7f14a8 >
@@ -205,12 +205,14 @@ needs to be pointed out separately during the onboarding.
205
205
automatically closed.
206
206
* Label your pull request with the ` doc ` , ` notable-change ` , and ` fast-track `
207
207
labels.
208
- * Run CI on the PR . Use the ` node-test-pull-request ` CI task.
208
+ * Run CI on the pull request . Use the ` node-test-pull-request ` CI task.
209
209
* After two Collaborator approvals for the change and two Collaborator approvals
210
- for fast-tracking, land the PR.
211
- * Leave a comment in the PR: ` Please 👍 this comment to approve fast-tracking ` .
210
+ for fast-tracking, land the pull request.
211
+ * Leave a comment in the pull request:
212
+ ` Please 👍 this comment to approve fast-tracking ` .
212
213
* If there are not enough approvals within a reasonable time, consider the
213
- single approval of the onboarding TSC member sufficient, and land the PR.
214
+ single approval of the onboarding TSC member sufficient, and land the pull
215
+ request.
214
216
* Be sure to add the ` PR-URL: <full-pr-url> ` and appropriate ` Reviewed-By: `
215
217
metadata.
216
218
* [ ` node-core-utils ` ] [ ] automates the generation of metadata and the landing
0 commit comments