Skip to content

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

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

Activity

  1. added
    contentThis issue or pull request belongs to the Docs Content team
    on Apr 28, 2026
  2. added
    triageDo not begin working on this issue until triaged by the team
    on Apr 28, 2026
  3. Sharra-writes commented on Apr 29, 2026

    @Sharra-writes
    Contributor

    @oskolist I think that change is fine, maybe a mention in the "next steps" section at the bottom with a link to setting a username. Conveniently, the "to learn more about using a private email address" line at the bottom should also be erased, and its link instead going at the end of the first paragraph, since the link there currently is self-referential and links back to the same page. :face_palm: It's a fairly simple fix, just placing/moving some links, so I'll add a help wanted label to this, and whoever wants to pick it up can.

  4. added
    help wantedAnyone is welcome to open a pull request to fix this issue
    get startedContent related to "Getting Started" doc set
    and removed
    triageDo not begin working on this issue until triaged by the team
    on Apr 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions