adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

Doc: Contribute: Add instructions for GitHub profile name and email

Browse source 
Fixes 78713
Add instructions to the "Git Setup" section to ensure that the user's
GitHub profile name is their full name (first and last) and that the
GitHub profile name and email address match the git config user.name
and user.email.

Page: contribute/guidelines
Tested with:
ninja html
python3 -m http.server 8000

Signed-off-by: Arrel Neumiller <rlneumiller@gmail.com>
This commit is contained in:
Arrel Neumiller 2024-09-21 18:58:05 +01:00 committed by Anas Nashif
parent 063b146eb4
commit 703eadde5c
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/contribute/guidelines.rst
View file

@ -351,6 +351,15 @@ address is ``z.developer@example.com``:
git config --global user.name "Zephyr Developer"
git config --global user.email "z.developer@example.com"
.. note::
``user.name`` must be your full name (first and last at minimum), not a
pseudonym or hacker handle. The email address that you use in your Git configuration must match the email
address you use to sign your commits. If they don't match, the CI system will
fail your pull request.
If you intend to edit commits using the Github.com UI, ensure that your github profile
``email address`` and profile ``name`` also match those used in your git configuration
(``user.name`` & ``user.email``).
Pull Request Guidelines
***********************