Skip to content
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.

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

doc: include a tip on how to get your Github ID #34832

Closed

Conversation

CodeLeom
Copy link

@CodeLeom CodeLeom commented Oct 4, 2024

Why:

The existing content tells the reader the GitHub no-reply email format but did not tell the readers how to get their Github ID. My PR added a tip on how the reader can get their Github ID and be able to formulate their no-reply email as explained in the content.

Closes:
N/A

What's being changed (if available, include any code snippets, screenshots, or gifs):

I included the tip, immediately after the Note.

Note

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 4, 2024
Copy link
Contributor

github-actions bot commented Oct 4, 2024

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review account-and-profile Content relating to account and profile and removed triage Do not begin working on this issue until triaged by the team labels Oct 4, 2024
@nguyenalex836
Copy link
Contributor

@CodeLeom Thanks so much for opening a PR! I'll get this triaged for review ✨

@github github deleted a comment from abdolla4 Oct 7, 2024
@github github deleted a comment from abdolla4 Oct 7, 2024
@subatoi
Copy link
Contributor

subatoi commented Oct 7, 2024

@CodeLeom 👋 Thanks for raising this—I don't necessarily think this is a bad addition, but it's hard to know how many people this would actually help. This is one of the reasons we ask contributors to raise issues before going ahead and raising PRs—that way everyone, and most importantly you as the contributor, has a better experience. In this case, it would have allowed us to establish beforehand whether this change is worth making. Since not everybody will use the API and it's far easier to get the ID in this context by navigating to https://github.com/settings/emails, as the documentation notes, I'm going to close this out. Don't be discouraged from looking at our issues marked help wanted and thank you for your interest in the GitHub Docs

@subatoi subatoi closed this Oct 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
account-and-profile Content relating to account and profile content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants