From 9b4403dd7d1fe2c356262de50d022c9510636bea Mon Sep 17 00:00:00 2001 From: Anna Henningsen Date: Tue, 21 Aug 2018 15:11:15 +0200 Subject: [PATCH] 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 Reviewed-By: Gus Caplan Reviewed-By: Vse Mozhet Byt Reviewed-By: Refael Ackermann Reviewed-By: James M Snell Reviewed-By: Joyee Cheung Reviewed-By: Ruben Bridgewater Reviewed-By: Trivikram Kamat Reviewed-By: George Adams --- doc/guides/contributing/pull-requests.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index 0ae30d5b7710ec..783d77c8c5730e 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