-
Notifications
You must be signed in to change notification settings - Fork 60.7k
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
Add GitHub no-reply email to example of adding co-authors #36134
base: main
Are you sure you want to change the base?
Conversation
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
👓 Previews for changed contentThis 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 changesYou 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.
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server |
@@ -56,7 +56,7 @@ You can use {% data variables.product.prodname_desktop %} to create a commit wit | |||
> | |||
> | |||
Co-authored-by: NAME <[email protected]> | |||
Co-authored-by: ANOTHER-NAME <[email protected]>" | |||
Co-authored-by: ANOTHER-NAME <[email protected]>" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this need to be all uppercase?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @dsherret and thanks for your interest in the docs—
I understand what you're trying to do here, but it's tricky because we normally use uppercase as part of our style for placeholders.
In this case, I can see this being useful, so I'd recommend making some slightly wider changes as follows:
If you're adding multiple co-authors, give each co-author their own line and
Co-authored-by:
commit trailer. Do not add blank lines between each co-author line.
In the following example, two co-authors are added. For the second co-author, a
noreply
email address is given (for an account created after July 18, 2017). For more information aboutnoreply
email addresses, see AUTOTITLE.
$ git commit -m "Refactor usability tests.
>
>
Co-authored-by: NAME <[email protected]>
Co-authored-by: ANOTHER-NAME <[email protected]>"
If you're happy to make these changes, I'm happy to get this merged.
Why:
Every few weeks I google how to do this and in addition to needing to google this, I also need to google what the no-reply email address is. Combining these two sets of information in the same docs would be helpful.
Closes: None
What's being changed (if available, include any code snippets, screenshots, or gifs):
Check off the following: