Skip to content

Commit eebecef

Browse files
TrottFishrock123
authored andcommitted
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: #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>
1 parent 30e995f commit eebecef

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

doc/onboarding.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -165,15 +165,13 @@ Update your `master` branch (or whichever branch you are landing on, almost alwa
165165

166166
Landing a PR
167167

168-
* if it all looks good, `curl -L 'url-of-pr.patch' | git am`
168+
* If it all looks good, `curl -L 'url-of-pr.patch' | git am`
169169
* If `git am` fails, see [the relevant section of the Onboarding Extras doc](./onboarding-extras.md#if-git-am-fails).
170170
* `git rebase -i upstream/master`
171-
* squash into logical commits if necessary
171+
* Squash into logical commits if necessary.
172172
* `./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.)
173173
* Amend the commit description.
174-
* Commits should be of the form `subsystem[,subsystem]: small description\n\nbig description\n\n<metadata>`
175-
* The first line should not exceed 50 characters.
176-
* The remaining lines (except for metadata lines) should wrap at 72 characters.
174+
* The commit message text must conform to the [commit message guidelines](../CONTRIBUTING.md#step-3-commit).
177175
* Add required metadata:
178176
* `PR-URL: <full-pr-url>`
179177
* `Reviewed-By: <collaborator name> <collaborator email>`

0 commit comments

Comments
 (0)