Skip to content

Commit faa55fb

Browse files
TrottMylesBorins
authored andcommitted
doc: edit CONTRIBUTING.md for clarity
PR-URL: #11045 Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Joyee Cheung <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Michal Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent c26258e commit faa55fb

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ For general help using Node.js, please file an issue at the
1616
[Node.js help repository](https://github.com/nodejs/help/issues).
1717

1818
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
2020
[Technical Steering Committee (TSC)](https://github.com/nodejs/TSC/issues)
2121
instead.
2222

@@ -112,8 +112,8 @@ changed and why. Follow these guidelines when writing one:
112112
lowercase with the exception of proper nouns, acronyms, and the ones that
113113
refer to code, like function/variable names. The description should
114114
be prefixed with the name of the changed subsystem and start with an
115-
imperative verb, for example, "net: add localAddress and localPort
116-
to Socket".
115+
imperative verb. Example: "net: add localAddress and localPort
116+
to Socket"
117117
2. Keep the second line blank.
118118
3. Wrap all other lines at 72 columns.
119119

@@ -124,11 +124,11 @@ subsystem: explain the commit in one line
124124
125125
Body of commit message is a few lines of text, explaining things
126126
in more detail, possibly giving some background about the issue
127-
being fixed, etc. etc.
127+
being fixed, etc.
128128
129129
The body of the commit message can be several paragraphs, and
130130
please do proper word-wrap and keep columns shorter than about
131-
72 characters or so. That way `git log` will show things
131+
72 characters or so. That way, `git log` will show things
132132
nicely even when it is indented.
133133
```
134134

@@ -173,19 +173,19 @@ $ ./configure && make -j4 test
173173
Windows:
174174

175175
```text
176-
.\vcbuild nosign test
176+
> vcbuild test
177177
```
178178

179179
(See the [BUILDING.md](./BUILDING.md) for more details.)
180180

181-
Make sure the linter is happy and that all tests pass. Please, do not submit
182-
patches that fail either check.
181+
Make sure the linter does not report any issues and that all tests pass. Please
182+
do not submit patches that fail either check.
183183

184-
Running `make test`/`.\vcbuild nosign test` will run the linter as well unless one or
184+
Running `make test`/`vcbuild test` will run the linter as well unless one or
185185
more tests fail.
186186

187187
If you want to run the linter without running tests, use
188-
`make lint`/`.\vcbuild nosign jslint`.
188+
`make lint`/`vcbuild lint`.
189189

190190
If you are updating tests and just want to run a single test to check it, you
191191
can use this syntax to run it exactly as the test harness would:
@@ -217,7 +217,7 @@ Pull requests are usually reviewed within a few days.
217217
### Step 7: Discuss and update
218218

219219
You will probably get feedback or requests for changes to your Pull Request.
220-
This is a big part of the submission process, so don't be disheartened!
220+
This is a big part of the submission process so don't be disheartened!
221221

222222
To make changes to an existing Pull Request, make the changes to your branch.
223223
When you push that branch to your fork, GitHub will automatically update the
@@ -255,15 +255,15 @@ If in doubt, you can always ask for guidance in the Pull Request or on
255255

256256
Feel free to post a comment in the Pull Request to ping reviewers if you are
257257
awaiting an answer on something. If you encounter words or acronyms that
258-
seem unfamiliar, check out this
258+
seem unfamiliar, refer to this
259259
[glossary](https://sites.google.com/a/chromium.org/dev/glossary).
260260

261261
Note that multiple commits often get squashed when they are landed (see the
262262
notes about [commit squashing](#commit-squashing)).
263263

264264
### Step 8: Landing
265265

266-
In order to get landed, a Pull Request needs to be reviewed and
266+
In order to land, a Pull Request needs to be reviewed and
267267
[approved](#getting-approvals-for-your-pull-request) by
268268
at least one Node.js Collaborator and pass a
269269
[CI (Continuous Integration) test run](#ci-testing).
@@ -283,8 +283,8 @@ your name on it. Congratulations and thanks for your contribution!
283283

284284
### Commit Squashing
285285

286-
When the commits in your Pull Request get landed, they will be squashed
287-
into one commit per logical change, with metadata added to the commit
286+
When the commits in your Pull Request land, they will be squashed
287+
into one commit per logical change. Metadata will be added to the commit
288288
message (including links to the Pull Request, links to relevant issues,
289289
and the names of the reviewers). The commit history of your Pull Request,
290290
however, will stay intact on the Pull Request page.
@@ -314,9 +314,9 @@ Every Pull Request needs to be tested
314314
to make sure that it works on the platforms that Node.js
315315
supports. This is done by running the code through the CI system.
316316

317-
Only a Collaborator can request a CI run. Usually one of them will do it
317+
Only a Collaborator can start a CI run. Usually one of them will do it
318318
for you as approvals for the Pull Request come in.
319-
If not, you can ask a Collaborator to request a CI run.
319+
If not, you can ask a Collaborator to start a CI run.
320320

321321
### Waiting Until the Pull Request Gets Landed
322322

0 commit comments

Comments
 (0)