diff options
| author | Rich Trott <rtrott@gmail.com> | 2016-09-09 21:02:46 -0700 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2016-09-12 21:18:42 -0700 |
| commit | 4a42ae3c6d06bfd1f21f8494d0863c1d764db0f6 (patch) | |
| tree | 2d069112004418a72517c16af05b5bbcbb0f5bd2 /doc/onboarding.md | |
| parent | d4061a63142004eee4ffc3de5fca7286cd330090 (diff) | |
| download | android-node-v8-4a42ae3c6d06bfd1f21f8494d0863c1d764db0f6.tar.gz android-node-v8-4a42ae3c6d06bfd1f21f8494d0863c1d764db0f6.tar.bz2 android-node-v8-4a42ae3c6d06bfd1f21f8494d0863c1d764db0f6.zip | |
doc: update onboarding PR landing info
Clarify a few items in the onboarding doc about landing a PR. One
addition is to include the optional `Refs:` metadata.
PR-URL: https://github.com/nodejs/node/pull/8479
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/onboarding.md')
| -rw-r--r-- | doc/onboarding.md | 26 |
1 files changed, 16 insertions, 10 deletions
diff --git a/doc/onboarding.md b/doc/onboarding.md index 2effe6051e..e1c1a5dca4 100644 --- a/doc/onboarding.md +++ b/doc/onboarding.md @@ -170,18 +170,24 @@ Landing a PR * `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 - * commits should follow `subsystem[,subsystem]: small description\n\nbig description\n\n<metadata>` - * first line 50 columns, all others 72 - * add metadata: - * `Fixes: <full-issue-url>` - * `Reviewed-By: human <email>` - * Easiest to use `git log` then do a search - * (`/Name` + `enter` (+ `n` as much as you need to) in vim) - * Only include collaborators who have commented `LGTM` +* Amend the commit description. + * Commits should be of the form `subsystem[,subsystem]: small description\n\nbig description\n\n<metadata>` + * The first line should not exceed 50 characters. + * The remaining lines (except for metadata lines) should wrap at 72 characters. + * Add required metadata: * `PR-URL: <full-pr-url>` + * `Reviewed-By: <collaborator name> <collaborator email>` + * Easiest to use `git log`, then do a search. + * 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. * `git push upstream master` - * close the original PR with "Landed in `<commit hash>`". + * Close the pull request with a "Landed in `<commit hash>`" comment. ## exercise: make PRs adding yourselves to the README |