diff options
| author | Anna Henningsen <anna@addaleax.net> | 2018-08-21 15:11:15 +0200 |
|---|---|---|
| committer | George Adams <george.adams@uk.ibm.com> | 2018-08-26 14:02:08 +0100 |
| commit | 99b1ada3313cfffa4cf4ef1e41d79e247e6b8994 (patch) | |
| tree | 86a67878271039ffeae321a7b60007898d1b3e2a /doc/guides/contributing | |
| parent | 1c05b16c9e7b8d054d1661c61ae054efe83108ac (diff) | |
| download | android-node-v8-99b1ada3313cfffa4cf4ef1e41d79e247e6b8994.tar.gz android-node-v8-99b1ada3313cfffa4cf4ef1e41d79e247e6b8994.tar.bz2 android-node-v8-99b1ada3313cfffa4cf4ef1e41d79e247e6b8994.zip | |
doc: clarify git config name/email requirements
The previous wording sounded like this was a necessary for
contributing. This clarifies that it is not, and tells people what
we do use their info for.
PR-URL: https://github.com/nodejs/node/pull/22433
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
Diffstat (limited to 'doc/guides/contributing')
| -rw-r--r-- | doc/guides/contributing/pull-requests.md | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index 0ae30d5b77..783d77c8c5 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -80,10 +80,15 @@ It is recommended to configure `git` so that it knows who you are: $ 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. + +You can use any name/email address you prefer here. We only use the +metadata generated by `git` using this configuration for properly attributing +your changes to you in the `AUTHORS` file and the changelog. + +If you would like for the Github UI to link the commit to your account +and award you the `Contributor` label after the changes have been merged, +make sure this local email is also added to your +[GitHub email list](https://github.com/settings/emails). ### Step 2: Branch |