Skip to content

Commit 72f0efc

Browse files
TrottBethGriggs
authored andcommitted
doc: edit Landing Pull Requests
Edit the Landing Pull Requests section of the Collaborators Guide for brevity and clarity. PR-URL: #26536 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Masashi Hirano <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
1 parent 132a457 commit 72f0efc

File tree

1 file changed

+19
-22
lines changed

1 file changed

+19
-22
lines changed

COLLABORATOR_GUIDE.md

+19-22
Original file line numberDiff line numberDiff line change
@@ -446,32 +446,30 @@ The TSC should serve as the final arbiter where required.
446446

447447
## Landing Pull Requests
448448

449-
1. Avoid landing PRs that are assigned to someone else. Authors who wish to land
450-
their own PRs will self-assign them, or delegate to someone else. If in
451-
doubt, ask the assignee whether it is okay to land.
449+
1. Avoid landing pull requests that have someone else as an assignee. Authors
450+
who wish to land their own pull requests will self-assign them. Sometimes, an
451+
author will delegate to someone else. If in doubt, ask the assignee whether
452+
it is okay to land.
452453
1. Never use GitHub's green ["Merge Pull Request"][] button. Reasons for not
453454
using the web interface button:
454455
* The "Create a merge commit" method will add an unnecessary merge commit.
455-
* The "Squash and merge" method will add metadata (the PR #) to the commit
456-
title. If more than one author has contributed to the PR, squashing will
457-
only keep the most recent author.
456+
* The "Squash and merge" method will add metadata (the pull request #) to the
457+
commit title. If more than one author contributes to the pull request,
458+
squashing only keeps one author.
458459
* The "Rebase and merge" method has no way of adding metadata to the commit.
459-
1. Make sure the CI is done and the result is green. If the CI is not green,
460-
check for flaky tests and infrastructure failures. Please check if those were
461-
already reported in the appropriate repository ([node][flaky tests] and
462-
[build](https://github.com/nodejs/build/issues)) or not and open new issues
463-
in case they are not. If no CI was run or the run is outdated because code
464-
was pushed after the last run, please first start a new CI and wait for the
465-
result. If no CI is required, please leave a comment in case none is already
466-
present.
467-
1. Review the commit message to ensure that it adheres to the guidelines
468-
outlined in the [contributing][] guide.
460+
1. Make sure CI is complete and green. If the CI is not green, check for
461+
unreliable tests and infrastructure failures. If there are not corresponding
462+
issues in the [node][unreliable tests] or
463+
[build](https://github.com/nodejs/build/issues) repositories, open new
464+
issues. Run a new CI any time someone pushes new code to the pull request.
465+
1. Check that the commit message adheres to [commit message guidelines][].
469466
1. Add all necessary [metadata](#metadata) to commit messages before landing. If
470467
you are unsure exactly how to format the commit messages, use the commit log
471468
as a reference. See [this commit][commit-example] as an example.
472469

473-
For PRs from first-time contributors, be [welcoming](#welcoming-first-time-contributors).
474-
Also, verify that their git settings are to their liking.
470+
For pull requests from first-time contributors, be
471+
[welcoming](#welcoming-first-time-contributors). Also, verify that their git
472+
settings are to their liking.
475473

476474
All commits should be self-contained, meaning every commit should pass all
477475
tests. This makes it much easier when bisecting to find a breaking change.
@@ -608,8 +606,7 @@ commit message for that commit. This is a good moment to fix incorrect
608606
commit logs, ensure that they are properly formatted, and add
609607
`Reviewed-By` lines.
610608

611-
* The commit message text must conform to the
612-
[commit message guidelines](./doc/guides/contributing/pull-requests.md#commit-message-guidelines).
609+
* The commit message text must conform to the [commit message guidelines][].
613610

614611
<a name="metadata"></a>
615612
* Modify the original commit message to include additional metadata regarding
@@ -851,12 +848,12 @@ If you cannot find who to cc for a file, `git shortlog -n -s <file>` may help.
851848
[`--throw-deprecation`]: doc/api/cli.md#--throw-deprecation
852849
[`node-core-utils`]: https://github.com/nodejs/node-core-utils
853850
[backporting guide]: doc/guides/backporting-to-release-lines.md
854-
[contributing]: ./doc/guides/contributing/pull-requests.md#commit-message-guidelines
851+
[commit message guidelines]: ./doc/guides/contributing/pull-requests.md#commit-message-guidelines
855852
[commit-example]: https://github.com/nodejs/node/commit/b636ba8186
856-
[flaky tests]: https://github.com/nodejs/node/issues?q=is%3Aopen+is%3Aissue+label%3A%22CI+%2F+flaky+test%22y
857853
[git-node]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md
858854
[git-node-metadata]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md#git-node-metadata
859855
[git-username]: https://help.github.com/articles/setting-your-username-in-git/
860856
[git-email]: https://help.github.com/articles/setting-your-commit-email-address-in-git/
861857
[node-core-utils-credentials]: https://github.com/nodejs/node-core-utils#setting-up-credentials
862858
[node-core-utils-issues]: https://github.com/nodejs/node-core-utils/issues
859+
[unreliable tests]: https://github.com/nodejs/node/issues?q=is%3Aopen+is%3Aissue+label%3A%22CI+%2F+flaky+test%22

0 commit comments

Comments
 (0)