]> git.ipfire.org Git - thirdparty/git.git/commitdiff
.github/PULL_REQUEST_TEMPLATE.md: add a note about single-commit PRs
authorPhilippe Blain <levraiphilippeblain@gmail.com>
Tue, 6 Feb 2024 13:20:12 +0000 (13:20 +0000)
committerJunio C Hamano <gitster@pobox.com>
Tue, 6 Feb 2024 20:22:55 +0000 (12:22 -0800)
Contributors using Gitgitgadget continue to send single-commit PRs with
their commit message text duplicated below the three-dash line,
increasing the signal-to-noise ratio for reviewers.

This is because Gitgitgadget copies the pull request description as an
in-patch commentary, for single-commit PRs, and _GitHub_ defaults to
prefilling the pull request description with the commit message, for
single-commit PRs (followed by the content of the pull request
template).

Add a note in the pull request template mentioning that for
single-commit PRs, the PR description should thus be kept empty, in the
hope that contributors read it and act on it.

This partly addresses:
https://github.com/gitgitgadget/gitgitgadget/issues/340

Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
.github/PULL_REQUEST_TEMPLATE.md

index 952c7c3a2aa11ea1087390be61eab6f7c0013599..37654cdfd7abcf7ca310ecf2c67c694fb94ad113 100644 (file)
@@ -4,4 +4,7 @@ a mailing list (git@vger.kernel.org) for code submissions, code reviews, and
 bug reports. Nevertheless, you can use GitGitGadget (https://gitgitgadget.github.io/)
 to conveniently send your Pull Requests commits to our mailing list.
 
+For a single-commit pull request, please *leave the pull request description
+empty*: your commit message itself should describe your changes.
+
 Please read the "guidelines for contributing" linked above!