diff options
| author | Rich Trott <rtrott@gmail.com> | 2016-09-13 20:48:59 -0700 |
|---|---|---|
| committer | Jeremiah Senkpiel <fishrock123@rocketmail.com> | 2016-10-11 12:26:34 -0400 |
| commit | eebecef9a484720863ddc52eff0a7f8a3e4b9081 (patch) | |
| tree | 2cec039af46f5230e24e4a30c005970c6831b901 /doc/onboarding.md | |
| parent | 30e995f7143cdc856cb3400375f383590e3ed25c (diff) | |
| download | node-new-eebecef9a484720863ddc52eff0a7f8a3e4b9081.tar.gz | |
doc: link onboarding to contributing guide
Replace the description of the commit message requirements in
onboarding.md with a link to the commit message requirements as they
appear in the CONTRIBUTING.md.
Advantages include:
* Only one place to keep the commit message requirements up to date
* Most collaborators being onboarded will already have several commits
in their name and already be familiar with the requirements. So
repeating information here makes finding the new information (about
metadata, for example) harder to find.
PR-URL: https://github.com/nodejs/node/pull/8529
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/onboarding.md')
| -rw-r--r-- | doc/onboarding.md | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/doc/onboarding.md b/doc/onboarding.md index e1c1a5dca4..f554d5f010 100644 --- a/doc/onboarding.md +++ b/doc/onboarding.md @@ -165,15 +165,13 @@ Update your `master` branch (or whichever branch you are landing on, almost alwa Landing a PR -* if it all looks good, `curl -L 'url-of-pr.patch' | git am` +* 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 +* 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 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. + * The commit message text must conform to the [commit message guidelines](../CONTRIBUTING.md#step-3-commit). * Add required metadata: * `PR-URL: <full-pr-url>` * `Reviewed-By: <collaborator name> <collaborator email>` |