Skip to content

Commit 1e5b40c

Browse files
Trottjasnell
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 b1d9028 commit 1e5b40c

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

CONTRIBUTING.md

Lines changed: 21 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

@@ -109,8 +109,12 @@ Writing good commit logs is important. A commit log should describe what
109109
changed and why. Follow these guidelines when writing one:
110110

111111
1. The first line should be 50 characters or less and contain a short
112-
description of the change prefixed with the name of the changed
113-
subsystem (e.g. "net: add localAddress and localPort to Socket").
112+
description of the change. All words in the description should be in
113+
lowercase with the exception of proper nouns, acronyms, and the ones that
114+
refer to code, like function/variable names. The description should
115+
be prefixed with the name of the changed subsystem and start with an
116+
imperative verb. Example: "net: add localAddress and localPort
117+
to Socket"
114118
2. Keep the second line blank.
115119
3. Wrap all other lines at 72 columns.
116120

@@ -121,11 +125,11 @@ subsystem: explaining the commit in one line
121125
122126
Body of commit message is a few lines of text, explaining things
123127
in more detail, possibly giving some background about the issue
124-
being fixed, etc. etc.
128+
being fixed, etc.
125129
126130
The body of the commit message can be several paragraphs, and
127131
please do proper word-wrap and keep columns shorter than about
128-
72 characters or so. That way `git log` will show things
132+
72 characters or so. That way, `git log` will show things
129133
nicely even when it is indented.
130134
```
131135

@@ -167,19 +171,19 @@ $ ./configure && make -j8 test
167171
Windows:
168172

169173
```text
170-
.\vcbuild nosign test
174+
> vcbuild test
171175
```
172176

173177
(See the [BUILDING.md](./BUILDING.md) for more details.)
174178

175-
Make sure the linter is happy and that all tests pass. Please, do not submit
176-
patches that fail either check.
179+
Make sure the linter does not report any issues and that all tests pass. Please
180+
do not submit patches that fail either check.
177181

178-
Running `make test`/`.\vcbuild nosign test` will run the linter as well unless one or
182+
Running `make test`/`vcbuild test` will run the linter as well unless one or
179183
more tests fail.
180184

181185
If you want to run the linter without running tests, use
182-
`make lint`/`.\vcbuild nosign jslint`.
186+
`make lint`/`vcbuild lint`.
183187

184188
If you are updating tests and just want to run a single test to check it, you
185189
can use this syntax to run it exactly as the test harness would:
@@ -211,7 +215,7 @@ Pull requests are usually reviewed within a few days.
211215
### Step 7: Discuss and update
212216

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

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

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

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

258262
### Step 8: Landing
259263

260-
In order to get landed, a Pull Request needs to be reviewed and
264+
In order to land, a Pull Request needs to be reviewed and
261265
[approved](#getting-approvals-for-your-pull-request) by
262266
at least one Node.js Collaborator and pass a
263267
[CI (Continuous Integration) test run](#ci-testing).
@@ -277,8 +281,8 @@ your name on it. Congratulations and thanks for your contribution!
277281

278282
### Commit Squashing
279283

280-
When the commits in your Pull Request get landed, they will be squashed
281-
into one commit per logical change, with metadata added to the commit
284+
When the commits in your Pull Request land, they will be squashed
285+
into one commit per logical change. Metadata will be added to the commit
282286
message (including links to the Pull Request, links to relevant issues,
283287
and the names of the reviewers). The commit history of your Pull Request,
284288
however, will stay intact on the Pull Request page.
@@ -308,9 +312,9 @@ Every Pull Request needs to be tested
308312
to make sure that it works on the platforms that Node.js
309313
supports. This is done by running the code through the CI system.
310314

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

315319
### Waiting Until the Pull Request Gets Landed
316320

0 commit comments

Comments
 (0)