Re: [PATCH 3/3] MyFirstContribution: drop PR description for GGG single-patch contributions

From: Junio C Hamano <gitster@pobox.com>
Date: Apr 27, 2022, 21:56 UTC
Message-ID: <xmqqmtg6jim2.fsf@gitster.g>
In-Reply-To: <2f6ecbf260135efc2a7ad09564cf6c64ed6d6f0d.1651086288.git.gitgitgadget@gmail.com>

"Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 7 quoted lines

> +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, separately from your commit message.

"separately from your commit message" wants to be clarified. It sounds as if GGG will send a separate message.

I am _guessing_ that you meant something like "the body of your proposed log message ends with your sign-off and followed by a line with three-dashes on it. After that three-dash line, and before the diffstat and the patch, is an appropriate place to write additional information that are meant to help reviewers during review but will become irrelevant after the review is done. Your PR description will appear there for a single patch contribution".

If we do not explain the space after the three-dash line elsewhere, perhaps we should do so separately, like we talk about cover letters.

Thanks.