Skip to content

How to add your name as a contributor to the repo

Miguel González-Fierro edited this page Mar 9, 2022 · 6 revisions

We want to give visibility to everyone contributing to the repo. You can follow the next steps

Make sure that your GitHub user is setup correctly

To configure your user in all PC repositories:

git config --global user.name "Your Name"
git config --global user.email [email protected]

Please substitute Your Name with the name you want to appear in the commits and your-github-username with your GitHub username.

Tips and tricks: the alias [email protected] is a your default hidden email in Github. You can also use your real email if you prefer.

To configure your user in a single repository:

git config user.name "Your Name"
git config user.email [email protected]

To view the user and email configured in the repository:

git config user.name
git config user.email

Add your name in AUTHORS.md

After making a contribution to the repo that is significant enough, please go ahead and add your name to AUTHORS.md, in the section of contributors. Please follow the alphabetic sorting.