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

Add GitHub no-reply email to example of adding co-authors #36134

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dsherret
Copy link

@dsherret dsherret commented Feb 1, 2025

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:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the preview environment.

Copy link

welcome bot commented Feb 1, 2025

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.

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

github-actions bot commented Feb 1, 2025

👓 Previews for changed content

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 review server. 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
pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server
This table is posted from the Content Changes Table Comment workflow.

@@ -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]>"
Copy link
Author

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?

@subatoi subatoi 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 and removed triage Do not begin working on this issue until triaged by the team labels Feb 3, 2025
Copy link
Contributor

@subatoi subatoi left a 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 about noreply 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.

@subatoi subatoi added the more-information-needed More information is needed to complete review label Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team more-information-needed More information is needed to complete review 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.

2 participants