Skip to content

Commit c62b6b8

Browse files
committed
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: #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>
1 parent 35d6b4c commit c62b6b8

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

doc/guides/contributing/pull-requests.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,15 @@ It is recommended to configure `git` so that it knows who you are:
8080
$ git config user.name "J. Random User"
8181
$ git config user.email "j.random.user@example.com"
8282
```
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.
83+
84+
You can use any name/email address you prefer here. We only use the
85+
metadata generated by `git` using this configuration for properly attributing
86+
your changes to you in the `AUTHORS` file and the changelog.
87+
88+
If you would like for the Github UI to link the commit to your account
89+
and award you the `Contributor` label after the changes have been merged,
90+
make sure this local email is also added to your
91+
[GitHub email list](https://github.com/settings/emails).
8792

8893
### Step 2: Branch
8994

0 commit comments

Comments
 (0)