Skip to content

Latest commit

 

History

History
83 lines (60 loc) · 5.5 KB

creating-a-commit-with-multiple-authors.md

File metadata and controls

83 lines (60 loc) · 5.5 KB
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.github %}{% ifversion ghes %} and can be included in the profile contributions graph and the repository's statistics{% endif %}.
/articles/creating-a-commit-with-multiple-authors
/github/committing-changes-to-your-project/creating-a-commit-with-multiple-authors
/github/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors
fpt ghes ghec
*
*
*
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 {% data variables.location.product_location %}.

{% ifversion fpt or ghec %}

If a person chooses to keep their email address private, you should use their {% data variables.product.github %}-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.github %}-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

You can help a co-author find their preferred email address by sharing this information:

  • To find your {% data variables.product.github %}-provided no-reply email, 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.email on the command line.

{% 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 %}

  1. 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] 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.

  2. On the next line of the commit message, type Co-authored-by: name <[email protected]> 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. Do not add blank lines between each co-author line.

    $ git commit -m "Refactor usability tests.
>
>
Co-authored-by: NAME <[email protected]>
Co-authored-by: ANOTHER-NAME <[email protected]>"

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.github %}

After you've made changes in a file using the web editor on {% data variables.product.github %}, 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 %}

  1. Click Commit changes...
  2. In the "Commit message" field, type a short, meaningful commit message that describes the changes you made.
  3. In the text box below your commit message, add Co-authored-by: name <[email protected]> with specific information for each co-author. If you're adding multiple co-authors, give each co-author their own line and Co-authored-by: commit trailer.
  4. Click Commit changes or Propose changes.

The new commit and message will appear on {% data variables.location.product_location %}.

Further reading

{% ifversion ghes %}