Skip to content

Commit 8b1db6d

Browse files
committed
doc: add instructions to update local git config
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: #19777 Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent f02e4b9 commit 8b1db6d

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

doc/guides/contributing/pull-requests.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -62,18 +62,6 @@ These are detailed in the [Building guide][].
6262
Once you have `git` and are sure you have all of the necessary dependencies,
6363
it's time to create a fork.
6464

65-
Before getting started, it is recommended to configure `git` so that it knows
66-
who you are:
67-
68-
```text
69-
$ git config --global user.name "J. Random User"
70-
$ git config --global user.email "[email protected]"
71-
```
72-
Please make sure this local email is also added to your
73-
[GitHub email list](https://github.com/settings/emails) so that your commits
74-
will be properly associated with your account and you will be promoted
75-
to Contributor once your first commit is landed.
76-
7765
### Step 1: Fork
7866

7967
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
8674
$ git fetch upstream
8775
```
8876

77+
It is recommended to configure `git` so that it knows who you are:
78+
79+
```text
80+
$ git config user.name "J. Random User"
81+
$ git config user.email "[email protected]"
82+
```
83+
Please make sure this local email is also added to your
84+
[GitHub email list](https://github.com/settings/emails) so that your commits
85+
will be properly associated with your account and you will be promoted
86+
to Contributor once your first commit is landed.
87+
8988
### Step 2: Branch
9089

9190
As a best practice to keep your development environment as organized as

0 commit comments

Comments
 (0)