summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilippe Blain <levraiphilippeblain@gmail.com>2022-05-12 23:43:37 (GMT)
committerJunio C Hamano <gitster@pobox.com>2022-05-13 01:10:00 (GMT)
commit4ec50080621f1072a51351cb0f93d1af15a3c531 (patch)
tree4db0a1f3f085f16ed5bf941881fbedef6ef1cfa5
parentc2cd4b592f89c4d11570c815f80b1a45266e4939 (diff)
downloadgit-4ec50080621f1072a51351cb0f93d1af15a3c531.zip
git-4ec50080621f1072a51351cb0f93d1af15a3c531.tar.gz
git-4ec50080621f1072a51351cb0f93d1af15a3c531.tar.bz2
MyFirstContribution: drop PR description for GGG single-patch contributions
By default, GitHub prefills the PR description using the commit message for single-commit PRs. This results in a duplicate commit message below the three-dash line if the contributor does not empty out the PR description before submitting, which adds noise for reviewers. Add a note to that effect in MyFirstContribution.txt. 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>
-rw-r--r--Documentation/MyFirstContribution.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
index 9eb2dfe..1da15d9 100644
--- a/Documentation/MyFirstContribution.txt
+++ b/Documentation/MyFirstContribution.txt
@@ -904,6 +904,16 @@ respectively as the subject and body of the cover letter for your change. Refer
to <<cover-letter,"The cover letter">> above for advice on how to title your
submission and what content to include in the description.
+NOTE: For single-patch contributions, your commit message should already be
+meaningful and explain at a high level the purpose (what is happening and why)
+of your patch, so you usually do not need any additional context. In that case,
+remove the PR description that GitHub automatically generates from your commit
+message (your PR description should be empty). If you do need to supply even
+more context, you can do so in that space and it will be appended to the email
+that GitGitGadget will send, between the three-dash line and the diffstat
+(see <<single-patch,Bonus Chapter: One-Patch Changes>> for how this looks once
+submitted).
+
When you're happy, submit your pull request.
[[run-ci-ggg]]