Clarify blank lines requirement for Co-authored-by #36811
Conversation
At the moment, these docs suggests that two blank lines are needed before the Co-authored-by trailers for github to recognise the declared co-authors. This is (now?) incorrect, as can be seen in [this commit](guardian/amigo@84df334), which only leaves one blank line but does display the two co-authors in the UI. This commit updates the docs to make it clearer that only one blank line is required. (I have been using `git commit --cleanup=verbatim` completely unnecessarily!) I’ve also added the missing leading `>` symbols before the trailers when writing the message in the shell (they’re added by bash and possibly others to indicate it’s a continuation line).
|
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
bot
added
the
triage
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksThe table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
subatoi
added
content
|
Many thanks @emdash-ie, we'll review this as soon as we can |
...nges-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md
Outdated
Show resolved
Hide resolved
…ing-and-editing-commits/creating-a-commit-with-multiple-authors.md
There was a problem hiding this comment.
Thanks @emdash-ie, this is a good addition and we appreciate you raising an issue and a PR to fix this! I just removed a Latin abbreviation as Microsoft Style doesn't like those, but other than that this is good to merge, so I'll get this in for you now ✨
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Why:
At the moment, these docs suggests that two blank lines are needed before the Co-authored-by trailers for github to recognise the declared co-authors. This is (now?) incorrect, as can be seen in this commit, which only leaves one blank line but does display the two co-authors in the UI.
Closes: #36812
What's being changed (if available, include any code snippets, screenshots, or gifs):
This commit updates the docs to make it clearer that only one blank line is required.
I’ve also added the missing leading
>symbols before the trailers when writing the message in the shell (they’re added by bash and possibly others to indicate it’s a continuation line).Check off the following: