diff options
author | Trivikram Kamat <16024985+trivikr@users.noreply.github.com> | 2018-04-03 11:39:56 -0700 |
---|---|---|
committer | Trivikram Kamat <16024985+trivikr@users.noreply.github.com> | 2018-04-05 18:40:53 -0700 |
commit | 8b1db6df8012a33b3da74de245074021c4c0c8ff (patch) | |
tree | 8c0c3693f39968c20d402e7e025a8c984ac4e4bf /doc/guides/contributing/pull-requests.md | |
parent | f02e4b90a2c1cdcb0b0d20bcfa75bac8d991d66b (diff) | |
download | android-node-v8-8b1db6df8012a33b3da74de245074021c4c0c8ff.tar.gz android-node-v8-8b1db6df8012a33b3da74de245074021c4c0c8ff.tar.bz2 android-node-v8-8b1db6df8012a33b3da74de245074021c4c0c8ff.zip |
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: 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>
Diffstat (limited to 'doc/guides/contributing/pull-requests.md')
-rw-r--r-- | doc/guides/contributing/pull-requests.md | 23 |
1 files changed, 11 insertions, 12 deletions
diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index 0bb4c4c003..4d22004664 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -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 |