COLLABORATOR_GUIDE.md and onboarding.md cover some of the same
information. The aim of this commit is to remove duplicated
information.
PR-URL: https://github.com/nodejs/node/pull/9635
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
@ -36,6 +36,8 @@ Collaborators or additional evidence that the issue has relevance, the
issue may be closed. Remember that issues can always be re-opened if
issue may be closed. Remember that issues can always be re-opened if
necessary.
necessary.
[**See "Who to CC in issues"**](./onboarding-extras.md#who-to-cc-in-issues)
## Accepting Modifications
## Accepting Modifications
All modifications to the Node.js code and documentation should be
All modifications to the Node.js code and documentation should be
@ -60,19 +62,20 @@ and work schedules. Trivial changes (e.g. those which fix minor bugs
or improve performance without affecting API or causing other
or improve performance without affecting API or causing other
wide-reaching impact) may be landed after a shorter delay.
wide-reaching impact) may be landed after a shorter delay.
For non-breaking changes, if there is no disagreement amongst Collaborators, a
For non-breaking changes, if there is no disagreement amongst
pull request may be landed given appropriate review. Where there is discussion
Collaborators, a pull request may be landed given appropriate review.
amongst Collaborators, consensus should be sought if possible. The
Where there is discussion amongst Collaborators, consensus should be
lack of consensus may indicate the need to elevate discussion to the
sought if possible. The lack of consensus may indicate the need to
CTC for resolution (see below).
elevate discussion to the CTC for resolution (see below).
Breaking changes (that is, pull requests that require an increase in the
Breaking changes (that is, pull requests that require an increase in
major version number, known as `semver-major` changes) must be elevated for
the major version number, known as `semver-major` changes) must be
review by the CTC. This does not necessarily mean that the PR must be put onto
elevated for review by the CTC. This does not necessarily mean that the
the CTC meeting agenda. If multiple CTC members approve (`LGTM`) the PR and no
PR must be put onto the CTC meeting agenda. If multiple CTC members
Collaborators oppose the PR, it can be landed. Where there is disagreement among
approve (`LGTM`) the PR and no Collaborators oppose the PR, it can be
CTC members or objections from one or more Collaborators, `semver-major` pull
landed. Where there is disagreement among CTC members or objections
requests should be put on the CTC meeting agenda.
from one or more Collaborators, `semver-major` pull requests should be
put on the CTC meeting agenda.
All bugfixes require a test case which demonstrates the defect. The
All bugfixes require a test case which demonstrates the defect. The
test should *fail* before the change, and *pass* after the change.
test should *fail* before the change, and *pass* after the change.
@ -96,13 +99,20 @@ The CTC should serve as the final arbiter where required.
## Landing Pull Requests
## Landing Pull Requests
* Please never use GitHub's green ["Merge Pull Request"](https://help.github.com/articles/merging-a-pull-request/#merging-a-pull-request-using-the-github-web-interface) button.
* If you do, please force-push removing the merge.
* Reasons for not using the web interface button:
* The merge method will add an unnecessary merge commit.
* The rebase & merge method adds metadata to the commit title.
* The rebase method changes the author.
* The squash & merge method has been known to add metadata to the
commit title.
* If more than one author has contributed to the PR, only the
latest author will be considered during the squashing.
Always modify the original commit message to include additional meta
Always modify the original commit message to include additional meta
information regarding the change process:
information regarding the change process:
- A `Reviewed-By: Name <email>` line for yourself and any
other Collaborators who have reviewed the change.
- Useful for @mentions / contact list if something goes wrong in the PR.
- Protects against the assumption that GitHub will be around forever.
- A `PR-URL:` line that references the *full* GitHub URL of the original
- A `PR-URL:` line that references the *full* GitHub URL of the original
pull request being merged so it's easy to trace a commit back to the
pull request being merged so it's easy to trace a commit back to the
conversation that led up to that change.
conversation that led up to that change.
@ -110,6 +120,10 @@ information regarding the change process:
for an issue, and/or the hash and commit message if the commit fixes
for an issue, and/or the hash and commit message if the commit fixes
a bug in a previous commit. Multiple `Fixes:` lines may be added if
a bug in a previous commit. Multiple `Fixes:` lines may be added if
appropriate.
appropriate.
- A `Reviewed-By: Name <email>` line for yourself and any
other Collaborators who have reviewed the change.
- Useful for @mentions / contact list if something goes wrong in the PR.
- Protects against the assumption that GitHub will be around forever.
Review the commit message to ensure that it adheres to the guidelines
Review the commit message to ensure that it adheres to the guidelines
outlined in the [contributing](https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#step-3-commit) guide.
outlined in the [contributing](https://github.com/nodejs/node/blob/master/CONTRIBUTING.md#step-3-commit) guide.
@ -119,7 +133,6 @@ See the commit log for examples such as
exactly how to format your commit messages.
exactly how to format your commit messages.
Additionally:
Additionally:
- Double check PRs to make sure the person's _full name_ and email
- Double check PRs to make sure the person's _full name_ and email
address are correct before merging.
address are correct before merging.
- Except when updating dependencies, all commits should be self
- Except when updating dependencies, all commits should be self
@ -224,16 +237,36 @@ Save the file and close the editor. You'll be asked to enter a new
commit message for that commit. This is a good moment to fix incorrect
commit message for that commit. This is a good moment to fix incorrect
commit logs, ensure that they are properly formatted, and add
commit logs, ensure that they are properly formatted, and add
`Reviewed-By` lines.
`Reviewed-By` lines.
* The commit message text must conform to the [commit message guidelines](../CONTRIBUTING.md#step-3-commit).
Time to push it:
Time to push it:
```text
```text
$ git push origin master
$ git push origin master
```
```
* Optional: Force push the amended commit to the branch you used to
open the pull request. If your branch is called `bugfix`, then the
command would be `git push --force-with-lease origin master:bugfix`.
When the pull request is closed, this will cause the pull request to
show the purple merged status rather than the red closed status that is
usually used for pull requests that weren't merged. Only do this when
landing your own contributions.
* Close the pull request with a "Landed in `<commit hash>`" comment. If
your pull request shows the purple merged status then you should still
add the "Landed in <commithash>..<commithash>" comment if you added
multiple commits.
* `./configure && make -j8 test`
* `-j8` builds node in parallel with 8 threads. Adjust to the number
of cores or processor-level threads your processor has (or slightly
more) for best results.
### I Just Made a Mistake
### I Just Made a Mistake
With `git`, there's a way to override remote trees by force pushing
* Ping a CTC member.
* `#node-dev` on freenode
* With `git`, there's a way to override remote trees by force pushing
(`git push -f`). This should generally be seen as forbidden (since
(`git push -f`). This should generally be seen as forbidden (since
you're rewriting history on a repository other people are working
you're rewriting history on a repository other people are working
against) but is allowed for simpler slip-ups such as typos in commit
against) but is allowed for simpler slip-ups such as typos in commit
@ -241,6 +274,9 @@ messages. However, you are only allowed to force push to any Node.js
branch within 10 minutes from your original push. If someone else
branch within 10 minutes from your original push. If someone else
pushes to the branch or the 10 minute period passes, consider the
pushes to the branch or the 10 minute period passes, consider the
commit final.
commit final.
* Use `--force-with-lease` to minimize the chance of overwriting
* There is [a bot](https://github.com/nodejs-github-bot/github-bot) that applies subsystem labels (for example, `doc`, `test`, `assert`, or `buffer`) so that we know what parts of the code base the pull request modifies. It is not perfect, of course. Feel free to apply relevant labels and remove irrelevant labels from pull requests and issues.
* There is [a bot](https://github.com/nodejs-github-bot/github-bot) that applies subsystem labels (for example, `doc`, `test`, `assert`, or `buffer`) so that we know what parts of the code base the pull request modifies. It is not perfect, of course. Feel free to apply relevant labels and remove irrelevant labels from pull requests and issues.
* It is not automatically run. You need to start it manually.
* It is not automatically run. You need to start it manually.
* Log in on CI is integrated with GitHub. Try to log in now!
* Log in on CI is integrated with GitHub. Try to log in now!
* You will be using `node-test-pull-request` most of the time. Go there now!
* You will be using `node-test-pull-request` most of the time. Go there now!
@ -130,85 +121,13 @@ onboarding session.
* Use the [Build WG repo](https://github.com/nodejs/build) to file issues for the Build WG members who maintain the CI infrastructure.
* Use the [Build WG repo](https://github.com/nodejs/build) to file issues for the Build WG members who maintain the CI infrastructure.
## Landing PRs: Overview
## Landing PRs
* The [Collaborator Guide](https://github.com/nodejs/node/blob/master/COLLABORATOR_GUIDE.md#technical-howto) is a great resource.
* No one (including TSC or CTC members) pushes directly to master without review.
* An exception is made for release commits only.
* One `LGTM` is sufficient, except for semver-major changes.
* More than one is better.
* Breaking changes must be LGTM'ed by at least two CTC members.
* If one or more Collaborators object to a change, it should not land until
the objection is addressed. The options for such a situation include:
* Engaging those with objections to determine a viable path forward;
* Altering the pull request to address the objections;
* Escalating the discussion to the CTC using the `ctc-review` label. This
should only be done after the previous options have been exhausted.
* Wait before merging non-trivial changes.
* 48 hours during the week and 72 hours on weekends.
* An example of a trivial change would be correcting the misspelling of a single word in a documentation file. This sort of change still needs to receive at least one `LGTM` but it does not need to wait 48 hours before landing.
* **Run the PR through CI before merging!**
* An exception can be made for documentation-only PRs as long as it does not include the `addons.md` documentation file. (Example code from that document is extracted and built as part of the tests!)
* What if something goes wrong?
* Ping a CTC member.
* `#node-dev` on freenode
* Force-pushing to fix things after is allowed for ~10 minutes. Avoid it if you can.
* Use `--force-with-lease` to minimize the chance of overwriting someone else's change.
* Post to `#node-dev` (IRC) if you force push.
## Landing PRs: Details
* Please never use GitHub's green ["Merge Pull Request"](https://help.github.com/articles/merging-a-pull-request/#merging-a-pull-request-using-the-github-web-interface) button.
* If you do, please force-push removing the merge.
* Reasons for not using the web interface button:
* The merge method will add an unnecessary merge commit.
* The rebase & merge method adds metadata to the commit title.
* The rebase method changes the author.
* The squash & merge method has been known to add metadata to the commit title.
* If more than one author has contributed to the PR, only the latest author will be considered during the squashing.
Update your `master` branch (or whichever branch you are landing on, almost always `master`)
* [**See "Updating Node.js from Upstream"**](./onboarding-extras.md#updating-nodejs-from-upstream)
Landing a PR
* If it all looks good, `curl -L 'url-of-pr.patch' | git am`
* If `git am` fails, see [the relevant section of the Onboarding Extras doc](./onboarding-extras.md#if-git-am-fails).
* `git rebase -i upstream/master`
* Squash into logical commits if necessary.
* `./configure && make -j8 test` (`-j8` builds node in parallel with 8 threads. adjust to the number of cores (or processor-level threads) your processor has (or slightly more) for best results.)
* Amend the commit description.
* The commit message text must conform to the [commit message guidelines](../CONTRIBUTING.md#step-3-commit).
* In vim: `/Name` + `enter` (+ `n` as much as you need to)
* Only include collaborators who have commented `LGTM`.
* Add additional metadata as appropriate:
* `Fixes: <full-issue-url>`
* Full URL of GitHub issue that the PR fixes.
* This will automatically close the PR when the commit lands in master.
* `Refs: <full-url>`
* Full URL of material that might provide additional useful information or context to someone trying to understand the change set or the thinking behind it.
* Optional: Force push the amended commit to the branch you used to open the pull request. If your branch is called `bugfix`, then the command would be `git push --force-with-lease origin master:bugfix`. When the pull request is closed, this will cause the pull request to show the purple merged status rather than the red closed status that is usually used for pull requests that weren't merged. Only do this when landing your own contributions.
* `git push upstream master`
* Close the pull request with a "Landed in `<commit hash>`" comment.
* [See the Collaborator Guide: Technical HOWTO](https://github.com/nodejs/node/blob/master/COLLABORATOR_GUIDE.md#technical-howto)
## Exercise: Make a PR adding yourself to the README
## Exercise: Make a PR adding yourself to the README
BethGriggs
8 years ago
Jeremiah Senkpiel