Skip to content

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

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 14, 2025
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa11ddc
Clarify blank lines requirement for Co-authored-by
emdash-ie Mar 13, 2025
3a10bfc
Update content/pull-requests/committing-changes-to-your-project/creat…
subatoi Mar 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions ...project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}

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
$ git commit -m "Refactor usability tests.
Expand All @@ -45,7 +45,7 @@ You can use {% data variables.product.prodname_desktop %} to create a commit wit
```

> [!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.

Expand All @@ -54,9 +54,8 @@ You can use {% data variables.product.prodname_desktop %} to create a commit wit
```shell
$ git commit -m "Refactor usability tests.
>
>
Co-authored-by: NAME <NAME@EXAMPLE.COM>
Co-authored-by: ANOTHER-NAME <ANOTHER-NAME@EXAMPLE.COM>"
> 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](/get-started/using-git/pushing-commits-to-a-remote-repository).
Expand Down