Skip to content

doc: link onboarding to contributing guide #8529

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Trott wants to merge 2 commits into from
Closed

doc: link onboarding to contributing guide #8529

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05336d2
doc: link onboarding to contributing guide
Trott Sep 14, 2016
30b9f20
squash: wording change
Trott Sep 14, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions doc/onboarding.md
View file
Open in desktop
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 [guidelines for contributing](../CONTRIBUTING.md#step-3-commit).
Copy link
Member

@lpinca lpinca Sep 14, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: s/guidelines for contributing/commit message guidelines/ ?

* Add required metadata:
* `PR-URL: <full-pr-url>`
* `Reviewed-By: <collaborator name> <collaborator email>`
Expand Down