Skip to content

Setting commit email address docs missing emphasis on user.name requirement #44015

@oskolist

Description

@oskolist

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/get-started/getting-started-with-git/setting-your-username-in-git
https://docs.github.com/en/account-and-profile/how-tos/email-preferences/setting-your-commit-email-address

What part(s) of the article would you like to see updated?

The documentation on setting commit email addresses
(https://docs.github.com/en/account-and-profile/how-tos/email-preferences/setting-your-commit-email-address)
doesn't clearly emphasize that git config user.name must ALSO be set for commits
to show your username and profile on GitHub.

Users following the email setup guide end up with unattributed commits if they
haven't already configured user.name. The docs should explicitly mention that
BOTH user.name and user.email are required for proper attribution.

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamget startedContent related to "Getting Started" doc sethelp wantedAnyone is welcome to open a pull request to fix this issue

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions