1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc,meta: refresh wording in colab guide

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/23292
Refs: https://github.com/nodejs/node/pull/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>
This commit is contained in:
Refael Ackermann 2018-10-06 10:36:23 -04:00
parent 0f8eaa4712
commit 39ae000429
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
COLLABORATOR_GUIDE.md
View File

@ -503,10 +503,11 @@ The TSC should serve as the final arbiter where required.
1. Never use GitHub's green ["Merge Pull Request"][] button. Reasons for not 1. Never use GitHub's green ["Merge Pull Request"][] button. Reasons for not
using the web interface button: using the web interface button:
* The merge method will add an unnecessary merge commit. * The "Create a merge commit" method will add an unnecessary merge commit.
* The squash & merge method can add metadata (the PR #) to the commit title. * The "Squash and merge" method will add metadata (the PR #) to the commit
* If more than one author has contributed to the PR, keep the most recent title. If more than one author has contributed to the PR, squashing will
author when squashing. only keep the most recent author.
* The "Rebase and merge" method has no way of adding metadata to the commit.
1. Make sure the CI is done and the result is green. If the CI is not green, 1. Make sure the CI is done and the result is green. If the CI is not green,
check for flaky tests and infrastructure failures. Please check if those were check for flaky tests and infrastructure failures. Please check if those were
already reported in the appropriate repository ([node][flaky tests] and already reported in the appropriate repository ([node][flaky tests] and
@ -517,13 +518,12 @@ The TSC should serve as the final arbiter where required.
present. present.
1. Review the commit message to ensure that it adheres to the guidelines 1. Review the commit message to ensure that it adheres to the guidelines
outlined in the [contributing][] guide. outlined in the [contributing][] guide.
1. Add all necessary [metadata](#metadata) to commit messages before landing. 1. Add all necessary [metadata](#metadata) to commit messages before landing. If
See the commit log for examples such as [this you are unsure exactly how to format the commit messages, use the commit log
one](https://github.com/nodejs/node/commit/b636ba8186) if unsure exactly how as a reference. See [this commit][commit-example] as an example.
to format your commit messages.
Check PRs from new contributors to make sure the person's name and email address For PRs from first time contributors, be [welcoming](#welcoming-first-time-contributors).
are correct before merging. Also, verify that their git settings are to their liking.
All commits should be self-contained, meaning every commit should pass all All commits should be self-contained, meaning every commit should pass all
tests. This makes it much easier when bisecting to find a breaking change. 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.
[`node-core-utils`]: https://github.com/nodejs/node-core-utils [`node-core-utils`]: https://github.com/nodejs/node-core-utils
[backporting guide]: doc/guides/backporting-to-release-lines.md [backporting guide]: doc/guides/backporting-to-release-lines.md
[contributing]: ./doc/guides/contributing/pull-requests.md#commit-message-guidelines [contributing]: ./doc/guides/contributing/pull-requests.md#commit-message-guidelines
[commit-example]: https://github.com/nodejs/node/commit/b636ba8186
[flaky tests]: https://github.com/nodejs/node/issues?q=is%3Aopen+is%3Aissue+label%3A%22CI+%2F+flaky+test%22y [flaky tests]: https://github.com/nodejs/node/issues?q=is%3Aopen+is%3Aissue+label%3A%22CI+%2F+flaky+test%22y
[git-node]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md [git-node]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md
[git-node-metadata]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md#git-node-metadata [git-node-metadata]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md#git-node-metadata