Skip to content

Document contributor email address #4220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+7 −0
Open

Document contributor email address #4220

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5332814
Document contributor email address
Eric-Arellano Nov 10, 2025
17a75b2
Fix typo
Eric-Arellano Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,13 @@ We also recommend running this command once to tell Git to ignore the `gh-pages`
git config --add remote.origin.fetch '^refs/heads/gh-pages'
```

### Git email address

To contribute code to this repository, your email must be configured properly with Git, as follows:

1. Run `git config --get user.email`. You do not need to make any further changes if the email address is one of the addresses set up with your github.com account.
2. Otherwise, run `git config --global user.email <your-email>`. Use an email address associated with your github.com account.

### Prerequisites to building the docs locally

We provide several tools to preview the documentation locally and to run quality checks. While many of these tools run in your PR through CI, we recommend installing them locally for faster iteration.
Expand Down