Co-authored-by: Peter Bengtsson <peterbe@github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
5.7 KiB
title, intro, redirect_from, versions, shortTitle
| title | intro | redirect_from | versions | shortTitle | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Creating a commit with multiple authors | You can attribute a commit to more than one author by adding one or more `Co-authored-by` trailers to the commit's message. Co-authored commits are visible on {% data variables.product.product_name %}{% ifversion ghes or ghae %} and can be included in the profile contributions graph and the repository's statistics{% endif %}. |
|
|
With multiple authors |
Required co-author information
Before you can add a co-author to a commit, you must know the appropriate email to use for each co-author. For the co-author's commit to count as a contribution, you must use the email associated with their account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %}.
{% ifversion fpt or ghec %}
If a person chooses to keep their email address private, you should use their {% data variables.product.product_name %}-provided no-reply email to protect their privacy. Otherwise, the co-author's email will be available to the public in the commit message. If you want to keep your email private, you can choose to use a {% data variables.product.product_name %}-provided no-reply email for Git operations and ask other co-authors to list your no-reply email in commit trailers.
For more information, see "AUTOTITLE."
{% tip %}
Tip: You can help a co-author find their preferred email address by sharing this information:
- To find your {% data variables.product.product_name %}-provided
no-replyemail, navigate to your email settings page under "Keep my email address private." - To find the email you used to configure Git on your computer, run
git config user.emailon the command line.
{% endtip %}
{% endif %}
Creating co-authored commits using {% data variables.product.prodname_desktop %}
You can use {% data variables.product.prodname_desktop %} to create a commit with a co-author. For more information, see "AUTOTITLE" and {% data variables.product.prodname_desktop %}.
Creating co-authored commits on the command line
{% data reusables.pull_requests.collect-co-author-commit-git-config-info %}
- Type your commit message and a short, meaningful description of your changes. After your commit description, instead of a closing quotation, add two empty lines.
$ git commit -m "Refactor usability tests.
>
>
{% tip %}
Tip: If you're using a text editor on the command line to type your commit message, ensure there are two newlines between the end of your commit description and the Co-authored-by: commit trailer.
{% endtip %}
- On the next line of the commit message, type
Co-authored-by: name <name@example.com>with specific information for each co-author. After the co-author information, add a closing quotation mark.
If you're adding multiple co-authors, give each co-author their own line and Co-authored-by: commit trailer.
$ git commit -m "Refactor usability tests.
>
>
Co-authored-by: NAME <NAME@EXAMPLE.COM>
Co-authored-by: ANOTHER-NAME <ANOTHER-NAME@EXAMPLE.COM>"
The new commit and message will appear on {% data variables.location.product_location %} the next time you push. For more information, see "AUTOTITLE."
Creating co-authored commits on {% data variables.product.product_name %}
After you've made changes in a file using the web editor on {% data variables.product.product_name %}, you can create a co-authored commit by adding a Co-authored-by: trailer to the commit's message.
{% data reusables.pull_requests.collect-co-author-commit-git-config-info %}
- Click Commit changes...
- In the "Commit message" field, type a short, meaningful commit message that describes the changes you made.
- In the text box below your commit message, add
Co-authored-by: name <name@example.com>with specific information for each co-author. If you're adding multiple co-authors, give each co-author their own line andCo-authored-by:commit trailer. - Click Commit changes or Propose changes.
The new commit and message will appear on {% data variables.location.product_location %}.
Further reading
{% ifversion ghes or ghae %}