]> git.ipfire.org Git - thirdparty/git.git/commitdiff
MyFirstContribution: reference "The cover letter" in GitGitGadget section
authorPhilippe Blain <levraiphilippeblain@gmail.com>
Thu, 12 May 2022 23:43:36 +0000 (23:43 +0000)
committerJunio C Hamano <gitster@pobox.com>
Fri, 13 May 2022 01:10:00 +0000 (18:10 -0700)
The "Sending Patches via GitGitGadget" section mentions that the PR
title and description will be used as the cover letter, but does not
explain what is a cover letter or what should be included in it.

Refer readers to the new "The cover letter" section added in a previous
commit.

Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/MyFirstContribution.txt

index f6ee5b8b1ae4bb7c359cf844003339df2b58475e..9eb2dfec95919b24f00008ef6fc9fd21936ab7a4 100644 (file)
@@ -899,8 +899,12 @@ https://github.com/gitgitgadget/git and open a PR either with the "New pull
 request" button or the convenient "Compare & pull request" button that may
 appear with the name of your newly pushed branch.
 
-Review the PR's title and description, as it's used by GitGitGadget as the cover
-letter for your change. When you're happy, submit your pull request.
+Review the PR's title and description, as they're used by GitGitGadget
+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.
+
+When you're happy, submit your pull request.
 
 [[run-ci-ggg]]
 === Running CI and Getting Ready to Send