Skip to content

Commit d08544f

Browse files
refackjasnell
authored andcommitted
doc,meta: refresh wording in colab guide
PR-URL: #23292 Refs: #23249 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
1 parent cabf144 commit d08544f

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

COLLABORATOR_GUIDE.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -503,10 +503,11 @@ The TSC should serve as the final arbiter where required.
503503

504504
1. Never use GitHub's green ["Merge Pull Request"][] button. Reasons for not
505505
using the web interface button:
506-
* The merge method will add an unnecessary merge commit.
507-
* The squash & merge method can add metadata (the PR #) to the commit title.
508-
* If more than one author has contributed to the PR, keep the most recent
509-
author when squashing.
506+
* The "Create a merge commit" method will add an unnecessary merge commit.
507+
* The "Squash and merge" method will add metadata (the PR #) to the commit
508+
title. If more than one author has contributed to the PR, squashing will
509+
only keep the most recent author.
510+
* The "Rebase and merge" method has no way of adding metadata to the commit.
510511
1. Make sure the CI is done and the result is green. If the CI is not green,
511512
check for flaky tests and infrastructure failures. Please check if those were
512513
already reported in the appropriate repository ([node][flaky tests] and
@@ -517,13 +518,12 @@ The TSC should serve as the final arbiter where required.
517518
present.
518519
1. Review the commit message to ensure that it adheres to the guidelines
519520
outlined in the [contributing][] guide.
520-
1. Add all necessary [metadata](#metadata) to commit messages before landing.
521-
See the commit log for examples such as [this
522-
one](https://github.com/nodejs/node/commit/b636ba8186) if unsure exactly how
523-
to format your commit messages.
521+
1. Add all necessary [metadata](#metadata) to commit messages before landing. If
522+
you are unsure exactly how to format the commit messages, use the commit log
523+
as a reference. See [this commit][commit-example] as an example.
524524

525-
Check PRs from new contributors to make sure the person's name and email address
526-
are correct before merging.
525+
For PRs from first time contributors, be [welcoming](#welcoming-first-time-contributors).
526+
Also, verify that their git settings are to their liking.
527527

528528
All commits should be self-contained, meaning every commit should pass all
529529
tests. This makes it much easier when bisecting to find a breaking change.
@@ -901,6 +901,7 @@ If you cannot find who to cc for a file, `git shortlog -n -s <file>` may help.
901901
[`node-core-utils`]: https://github.com/nodejs/node-core-utils
902902
[backporting guide]: doc/guides/backporting-to-release-lines.md
903903
[contributing]: ./doc/guides/contributing/pull-requests.md#commit-message-guidelines
904+
[commit-example]: https://github.com/nodejs/node/commit/b636ba8186
904905
[flaky tests]: https://github.com/nodejs/node/issues?q=is%3Aopen+is%3Aissue+label%3A%22CI+%2F+flaky+test%22y
905906
[git-node]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md
906907
[git-node-metadata]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md#git-node-metadata

0 commit comments

Comments
 (0)