Skip to content

Commit

Permalink
doc: move upstream information to onboarding doc
Browse files Browse the repository at this point in the history
Move information about setting `upstream` remote and updating from
`upstream` out of `onboarding-extras` and into `onboarding`. Previously,
a link was provided in `onboarding` to the section. This puts all the
git setup information for Collaborator onboardings in one place.

PR-URL: #21029
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
  • Loading branch information
Trott authored and MylesBorins committed Jun 6, 2018
1 parent 09aec43 commit f5bf2c8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 12 deletions.
10 changes: 0 additions & 10 deletions doc/onboarding-extras.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,13 +83,3 @@ need to be attached anymore, as only important bugfixes will be included.
* Architecture labels
* `arm`, `mips`, `s390`, `ppc`
* No x86{_64}, since that is the implied default

## Updating Node.js from Upstream

* `git remote add upstream git://github.com/nodejs/node.git`

to update from nodejs/node:

* `git checkout master`
* `git remote update -p` OR `git fetch --all`
* `git merge --ff-only upstream/master` (or `REMOTENAME/BRANCH`)
8 changes: 6 additions & 2 deletions doc/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,12 @@ onboarding session.
apply.whitespace fix`
* Always continue to PR from your own GitHub fork
* Branches in the `nodejs/node` repository are only for release lines
* See [Updating Node.js from Upstream][]
* Add the canonical nodejs repository as `upstream` remote:
* `git remote add upstream git://github.com/nodejs/node.git`
* To update from `upstream`:
* `git checkout master`
* `git remote update -p` OR `git fetch --all`
* `git merge --ff-only upstream/master` (or `REMOTENAME/BRANCH`)
* Make a new branch for each PR you submit.
* Membership: Consider making your membership in the Node.js GitHub
organization public. This makes it easier to identify Collaborators.
Expand Down Expand Up @@ -251,6 +256,5 @@ needs to be pointed out separately during the onboarding.
[Publicizing or hiding organization membership]: https://help.github.com/articles/publicizing-or-hiding-organization-membership/
[set up the credentials]: https://github.com/nodejs/node-core-utils#setting-up-credentials
[two-factor authentication]: https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/
[Updating Node.js from Upstream]: ./onboarding-extras.md#updating-nodejs-from-upstream
[using a TOTP mobile app]: https://help.github.com/articles/configuring-two-factor-authentication-via-a-totp-mobile-app/
[who-to-cc]: ../COLLABORATOR_GUIDE.md#who-to-cc-in-the-issue-tracker

0 comments on commit f5bf2c8

Please sign in to comment.