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>
Philippe Blain committed
May 12, 2022 at 23:43 UTC
4ec50080621f1072a51351cb0f93d1af15a3c531
1 file changed
+10
Documentation/MyFirstContribution.txt
+10
@@ -904,6 +904,16 @@ respectively as the subject and body of the cover letter for your change. Refer
904
to <<cover-letter,"The cover letter">> above for advice on how to title your
905
submission and what content to include in the description.
906
907
+NOTE: For single-patch contributions, your commit message should already be
908
+meaningful and explain at a high level the purpose (what is happening and why)
909
+of your patch, so you usually do not need any additional context. In that case,
910
+remove the PR description that GitHub automatically generates from your commit
911
+message (your PR description should be empty). If you do need to supply even
912
+more context, you can do so in that space and it will be appended to the email
913
+that GitGitGadget will send, between the three-dash line and the diffstat
914
+(see <<single-patch,Bonus Chapter: One-Patch Changes>> for how this looks once
915
+submitted).
916
+
917
When you're happy, submit your pull request.
918
919
[[run-ci-ggg]]