@@ -16,7 +16,7 @@ For general help using Node.js, please file an issue at the
16
16
[ Node.js help repository] ( https://github.com/nodejs/help/issues ) .
17
17
18
18
Discussion of non-technical topics including subjects like intellectual
19
- property, trademark and high level project questions should move to the
19
+ property, trademark, and high level project questions should move to the
20
20
[ Technical Steering Committee (TSC)] ( https://github.com/nodejs/TSC/issues )
21
21
instead.
22
22
@@ -109,8 +109,8 @@ changed and why. Follow these guidelines when writing one:
109
109
lowercase with the exception of proper nouns, acronyms, and the ones that
110
110
refer to code, like function/variable names. The description should
111
111
be prefixed with the name of the changed subsystem and start with an
112
- imperative verb, for example, "net: add localAddress and localPort
113
- to Socket".
112
+ imperative verb. Example: "net: add localAddress and localPort
113
+ to Socket"
114
114
2 . Keep the second line blank.
115
115
3 . Wrap all other lines at 72 columns.
116
116
@@ -121,11 +121,11 @@ subsystem: explain the commit in one line
121
121
122
122
Body of commit message is a few lines of text, explaining things
123
123
in more detail, possibly giving some background about the issue
124
- being fixed, etc. etc.
124
+ being fixed, etc.
125
125
126
126
The body of the commit message can be several paragraphs, and
127
127
please do proper word-wrap and keep columns shorter than about
128
- 72 characters or so. That way `git log` will show things
128
+ 72 characters or so. That way, `git log` will show things
129
129
nicely even when it is indented.
130
130
```
131
131
@@ -170,19 +170,19 @@ $ ./configure && make -j4 test
170
170
Windows:
171
171
172
172
``` text
173
- .\ vcbuild nosign test
173
+ > vcbuild test
174
174
```
175
175
176
176
(See the [ BUILDING.md] ( ./BUILDING.md ) for more details.)
177
177
178
- Make sure the linter is happy and that all tests pass. Please, do not submit
179
- patches that fail either check.
178
+ Make sure the linter does not report any issues and that all tests pass. Please
179
+ do not submit patches that fail either check.
180
180
181
- Running ` make test ` /` .\ vcbuild nosign test` will run the linter as well unless one or
181
+ Running ` make test ` /` vcbuild test ` will run the linter as well unless one or
182
182
more tests fail.
183
183
184
184
If you want to run the linter without running tests, use
185
- ` make lint ` /` .\ vcbuild nosign jslint ` .
185
+ ` make lint ` /` vcbuild lint ` .
186
186
187
187
If you are updating tests and just want to run a single test to check it, you
188
188
can use this syntax to run it exactly as the test harness would:
@@ -214,7 +214,7 @@ Pull requests are usually reviewed within a few days.
214
214
### Step 7: Discuss and update
215
215
216
216
You will probably get feedback or requests for changes to your Pull Request.
217
- This is a big part of the submission process, so don't be disheartened!
217
+ This is a big part of the submission process so don't be disheartened!
218
218
219
219
To make changes to an existing Pull Request, make the changes to your branch.
220
220
When you push that branch to your fork, GitHub will automatically update the
@@ -252,15 +252,15 @@ If in doubt, you can always ask for guidance in the Pull Request or on
252
252
253
253
Feel free to post a comment in the Pull Request to ping reviewers if you are
254
254
awaiting an answer on something. If you encounter words or acronyms that
255
- seem unfamiliar, check out this
255
+ seem unfamiliar, refer to this
256
256
[ glossary] ( https://sites.google.com/a/chromium.org/dev/glossary ) .
257
257
258
258
Note that multiple commits often get squashed when they are landed (see the
259
259
notes about [ commit squashing] ( #commit-squashing ) ).
260
260
261
261
### Step 8: Landing
262
262
263
- In order to get landed , a Pull Request needs to be reviewed and
263
+ In order to land , a Pull Request needs to be reviewed and
264
264
[ approved] ( #getting-approvals-for-your-pull-request ) by
265
265
at least one Node.js Collaborator and pass a
266
266
[ CI (Continuous Integration) test run] ( #ci-testing ) .
@@ -280,8 +280,8 @@ your name on it. Congratulations and thanks for your contribution!
280
280
281
281
### Commit Squashing
282
282
283
- When the commits in your Pull Request get landed , they will be squashed
284
- into one commit per logical change, with metadata added to the commit
283
+ When the commits in your Pull Request land , they will be squashed
284
+ into one commit per logical change. Metadata will be added to the commit
285
285
message (including links to the Pull Request, links to relevant issues,
286
286
and the names of the reviewers). The commit history of your Pull Request,
287
287
however, will stay intact on the Pull Request page.
@@ -311,9 +311,9 @@ Every Pull Request needs to be tested
311
311
to make sure that it works on the platforms that Node.js
312
312
supports. This is done by running the code through the CI system.
313
313
314
- Only a Collaborator can request a CI run. Usually one of them will do it
314
+ Only a Collaborator can start a CI run. Usually one of them will do it
315
315
for you as approvals for the Pull Request come in.
316
- If not, you can ask a Collaborator to request a CI run.
316
+ If not, you can ask a Collaborator to start a CI run.
317
317
318
318
### Waiting Until the Pull Request Gets Landed
319
319
0 commit comments