From: Philippe Blain via GitGitGadget Date: Thu, 12 May 2022 23:43:37 GMT Subject: [PATCH v3 5/5] MyFirstContribution: drop PR description for GGG single-patch contributions Message-ID: <76bcb6612e40aa3d5244658f9ff90f453222836a.1652399017.git.gitgitgadget@gmail.com> In-Reply-To: From: Philippe Blain 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 --- Documentation/MyFirstContribution.txt | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt index 9eb2dfec959..1da15d9ad44 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 <> 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 <> for how this looks once +submitted). + When you're happy, submit your pull request. [[run-ci-ggg]] -- gitgitgadget