Skip to content

Commit

Permalink
doc: link onboarding to contributing guide
Browse files Browse the repository at this point in the history
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: #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>
  • Loading branch information
Trott committed Sep 16, 2016
1 parent a01c365 commit 54dc719
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions doc/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>`
Expand Down

0 comments on commit 54dc719

Please sign in to comment.