jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Clarify blank lines requirement for Co-authored-by (#36811)

Browse Source 
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
This commit is contained in:
Emily Bourke
2025-03-14 11:49:47 +00:00
committed by GitHub
parent 0c47b74f4b
commit db0cf5dedf
1 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md
View File

@@ -36,7 +36,7 @@ You can use {% data variables.product.prodname_desktop %} to create a commit wit
{% data reusables.pull_requests.collect-co-author-commit-git-config-info %} {% 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. 1. Type your commit message and a short, meaningful description of your changes. After your commit description, instead of a closing quotation, add an empty line.
```shell ```shell
$ git commit -m "Refactor usability tests. $ git commit -m "Refactor usability tests.
@@ -45,7 +45,7 @@ You can use {% data variables.product.prodname_desktop %} to create a commit wit
``` ```
> [!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. > If you're using a text editor on the command line to type your commit message, ensure there is a blank line (two consecutive newlines) between the end of your commit description and the `Co-authored-by:` commit trailer.
1. 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. 1. 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.
@@ -54,9 +54,8 @@ You can use {% data variables.product.prodname_desktop %} to create a commit wit
```shell ```shell
$ git commit -m "Refactor usability tests. $ git commit -m "Refactor usability tests.
> >
> > Co-authored-by: NAME <NAME@EXAMPLE.COM>
Co-authored-by: NAME <NAME@EXAMPLE.COM> > Co-authored-by: ANOTHER-NAME <ANOTHER-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](/get-started/using-git/pushing-commits-to-a-remote-repository). The new commit and message will appear on {% data variables.location.product_location %} the next time you push. For more information, see [AUTOTITLE](/get-started/using-git/pushing-commits-to-a-remote-repository).