Skip to content

Commit 5777c79

Browse files
joyeecheungMylesBorins
authored andcommitted
doc: clarify the review and landing process
Adds/mentions: - Link to glossary - Commit squashing and CI run - 48/72 hour wait and PR review feature - Extra notes section - "Landed in <sha>" comment PR-URL: #10202 Ref: #10151 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Evan Lucas <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
1 parent fd195b4 commit 5777c79

File tree

1 file changed

+75
-8
lines changed

1 file changed

+75
-8
lines changed

CONTRIBUTING.md

+75-8
Original file line numberDiff line numberDiff line change
@@ -240,18 +240,85 @@ If in doubt, you can always ask for guidance in the Pull Request or on
240240
[IRC in the #node-dev channel](https://webchat.freenode.net?channels=node-dev&uio=d4).
241241

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

247+
Note that multiple commits often get squashed when they are landed (see the
248+
notes about [commit squashing](#commit-squashing)).
245249

246250
### Step 8: Landing
247251

248-
Once your Pull Request has been reviewed and approved by at least one Node.js
249-
Collaborators (often by saying LGTM, or Looks Good To Me), and as long as
250-
there is consensus (no objections from a Collaborator), a
251-
Collaborator can merge the Pull Request . GitHub often shows the Pull Request as
252-
`Closed` at this point, but don't worry. If you look at the branch you raised
253-
your Pull Request against (probably `master`), you should see a commit with
254-
your name on it. Congratulations and thanks for your contribution!
252+
In order to get landed, a Pull Request needs to be reviewed and
253+
[approved](#getting-approvals-for-your-pull-request) by
254+
at least one Node.js Collaborator and pass a
255+
[CI (Continuous Integration) test run](#ci-testing).
256+
After that, as long as there are no objections
257+
from a Collaborator, the Pull Request can be merged. If you find your
258+
Pull Request waiting longer than you expect, see the
259+
[notes about the waiting time](#waiting-until-the-pull-request-gets-landed).
260+
261+
When a collaborator lands your Pull Request, they will post
262+
a comment to the Pull Request page mentioning the commit(s) it
263+
landed as. GitHub often shows the Pull Request as `Closed` at this
264+
point, but don't worry. If you look at the branch you raised your
265+
Pull Request against (probably `master`), you should see a commit with
266+
your name on it. Congratulations and thanks for your contribution!
267+
268+
## Additional Notes
269+
270+
### Commit Squashing
271+
272+
When the commits in your Pull Request get landed, they will be squashed
273+
into one commit per logical change, with metadata added to the commit
274+
message (including links to the Pull Request, links to relevant issues,
275+
and the names of the reviewers). The commit history of your Pull Request,
276+
however, will stay intact on the Pull Request page.
277+
278+
For the size of "one logical change",
279+
[0b5191f](https://github.com/nodejs/node/commit/0b5191f15d0f311c804d542b67e2e922d98834f8)
280+
can be a good example. It touches the implementation, the documentation,
281+
and the tests, but is still one logical change. In general, the tests should
282+
always pass when each individual commit lands on the master branch.
283+
284+
### Getting Approvals for Your Pull Request
285+
286+
A Pull Request is approved either by saying LGTM, which stands for
287+
"Looks Good To Me", or by using GitHub's Approve button.
288+
GitHub's Pull Request review feature can be used during the process.
289+
For more information, check out
290+
[the video tutorial](https://www.youtube.com/watch?v=HW0RPaJqm4g)
291+
or [the official documentation](https://help.github.com/articles/reviewing-changes-in-pull-requests/).
292+
293+
After you push new changes to your branch, you need to get
294+
approval for these new changes again, even if GitHub shows "Approved"
295+
because the reviewers have hit the buttons before.
296+
297+
### CI Testing
298+
299+
Every Pull Request needs to be tested
300+
to make sure that it works on the platforms that Node.js
301+
supports. This is done by running the code through the CI system.
302+
303+
Only a Collaborator can request a CI run. Usually one of them will do it
304+
for you as approvals for the Pull Request come in.
305+
If not, you can ask a Collaborator to request a CI run.
306+
307+
### Waiting Until the Pull Request Gets Landed
308+
309+
A Pull Request needs to stay open for at least 48 hours (72 hours on a
310+
weekend) from when it is submitted, even after it gets approved and
311+
passes the CI. This is to make sure that everyone has a chance to
312+
weigh in. If the changes are trivial, collaborators may decide it
313+
doesn't need to wait. A Pull Request may well take longer to be
314+
merged in. All these precautions are important because Node.js is
315+
widely used, so don't be discouraged!
316+
317+
### Check Out the Collaborator's Guide
318+
319+
If you want to know more about the code review and the landing process,
320+
you can take a look at the
321+
[collaborator's guide](https://github.com/nodejs/node/blob/master/COLLABORATOR_GUIDE.md).
255322

256323
<a id="developers-certificate-of-origin"></a>
257324
## Developer's Certificate of Origin 1.1

0 commit comments

Comments
 (0)