mirrors/nodejs
mirrors/nodejs
0
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00
Code Issues Releases Activity

doc: add instructions to update local git config

Browse Source 
this code change updates pull-requests.md to instruct developers to
update their local git config instead of global. This way their global
git config won't be overwritten if they use different email ID for work
or personal or non-Github projects

PR-URL: https://github.com/nodejs/node/pull/19777
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Trivikram Kamat 2018-04-03 11:39:56 -07:00
parent f02e4b90a2
commit 8b1db6df80
1 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/guides/contributing/pull-requests.md
View File

@ -62,18 +62,6 @@ These are detailed in the [Building guide][].
Once you have `git` and are sure you have all of the necessary dependencies,
it's time to create a fork.
Before getting started, it is recommended to configure `git` so that it knows
who you are:
```text
$ git config --global user.name "J. Random User"
$ git config --global user.email "j.random.user@example.com"
```
Please make sure this local email is also added to your
[GitHub email list](https://github.com/settings/emails) so that your commits
will be properly associated with your account and you will be promoted
to Contributor once your first commit is landed.
### Step 1: Fork
Fork the project [on GitHub](https://github.com/nodejs/node) and clone your fork
@ -86,6 +74,17 @@ $ git remote add upstream https://github.com/nodejs/node.git
$ git fetch upstream
```
It is recommended to configure `git` so that it knows who you are:
```text
$ git config user.name "J. Random User"
$ git config user.email "j.random.user@example.com"
```
Please make sure this local email is also added to your
[GitHub email list](https://github.com/settings/emails) so that your commits
will be properly associated with your account and you will be promoted
to Contributor once your first commit is landed.
### Step 2: Branch
As a best practice to keep your development environment as organized as