Skip to content

Commit 78307f1

Browse files
phil-blaingitster
authored andcommitted
.github/PULL_REQUEST_TEMPLATE.md: add a note about single-commit PRs
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: gitgitgadget/gitgitgadget#340 Signed-off-by: Philippe Blain <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 564d025 commit 78307f1

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,7 @@ a mailing list ([email protected]) for code submissions, code reviews, and
44
bug reports. Nevertheless, you can use GitGitGadget (https://gitgitgadget.github.io/)
55
to conveniently send your Pull Requests commits to our mailing list.
66

7+
For a single-commit pull request, please *leave the pull request description
8+
empty*: your commit message itself should describe your changes.
9+
710
Please read the "guidelines for contributing" linked above!

0 commit comments

Comments
 (0)