Skip to content

Commit 989d2cd

Browse files
Trottitaloacasas
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 13a024d commit 989d2cd

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

CONTRIBUTING.md

+17-17
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

@@ -109,8 +109,8 @@ changed and why. Follow these guidelines when writing one:
109109
lowercase with the exception of proper nouns, acronyms, and the ones that
110110
refer to code, like function/variable names. The description should
111111
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"
114114
2. Keep the second line blank.
115115
3. Wrap all other lines at 72 columns.
116116

@@ -121,11 +121,11 @@ subsystem: explain the commit in one line
121121
122122
Body of commit message is a few lines of text, explaining things
123123
in more detail, possibly giving some background about the issue
124-
being fixed, etc. etc.
124+
being fixed, etc.
125125
126126
The body of the commit message can be several paragraphs, and
127127
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
129129
nicely even when it is indented.
130130
```
131131

@@ -170,19 +170,19 @@ $ ./configure && make -j4 test
170170
Windows:
171171

172172
```text
173-
.\vcbuild nosign test
173+
> vcbuild test
174174
```
175175

176176
(See the [BUILDING.md](./BUILDING.md) for more details.)
177177

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.
180180

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
182182
more tests fail.
183183

184184
If you want to run the linter without running tests, use
185-
`make lint`/`.\vcbuild nosign jslint`.
185+
`make lint`/`vcbuild lint`.
186186

187187
If you are updating tests and just want to run a single test to check it, you
188188
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.
214214
### Step 7: Discuss and update
215215

216216
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!
218218

219219
To make changes to an existing Pull Request, make the changes to your branch.
220220
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
252252

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

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

261261
### Step 8: Landing
262262

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
264264
[approved](#getting-approvals-for-your-pull-request) by
265265
at least one Node.js Collaborator and pass a
266266
[CI (Continuous Integration) test run](#ci-testing).
@@ -280,8 +280,8 @@ your name on it. Congratulations and thanks for your contribution!
280280

281281
### Commit Squashing
282282

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
285285
message (including links to the Pull Request, links to relevant issues,
286286
and the names of the reviewers). The commit history of your Pull Request,
287287
however, will stay intact on the Pull Request page.
@@ -311,9 +311,9 @@ Every Pull Request needs to be tested
311311
to make sure that it works on the platforms that Node.js
312312
supports. This is done by running the code through the CI system.
313313

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
315315
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.
317317

318318
### Waiting Until the Pull Request Gets Landed
319319

0 commit comments

Comments
 (0)