Skip to content

Documentation says two blank lines are necessary before Co-authored-by trailers, but one blank line is sufficient #36812

@emdash-ie

Description

@emdash-ie

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors

What part(s) of the article would you like to see updated?

At the moment, these docs say two blank lines are required before Co-authored-by trailers to mark a commit as having multiple authors.

However, it appears one blank line is sufficient, as can be seen in this commit, which has the two co-authors recognised in the UI.

Additional information

A requirement for two blank lines is a particularly annoying one because git defaults to removing consecutive blank lines unless prevented to with git commit --cleanup=verbatim.

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions