From: Philippe Blain <levraiphilippeblain@gmail.com>
To: Junio C Hamano <gitster@pobox.com>,
Philippe Blain via GitGitGadget <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Emily Shaffer <emilyshaffer@google.com>,
Johannes Schindelin <Johannes.Schindelin@gmx.de>
Subject: Re: [PATCH 3/3] MyFirstContribution: drop PR description for GGG single-patch contributions
Date: Thu, 28 Apr 2022 14:25:59 -0400 [thread overview]
Message-ID: <73b8834b-c2be-7e47-0f77-4853a5a051b7@gmail.com> (raw)
In-Reply-To: <xmqqmtg6jim2.fsf@gitster.g>
Le 2022-04-27 à 17:56, Junio C Hamano a écrit :
> "Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
>> +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".
Yes, this is what I meant. I'll try to phrase it differently.
>
> 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.
Yeah, it is explained in the "Bonus Chapter: One-Patch Changes" subsection [1]
at the end of the "Sending Patches with git send-email" section, so I guess
people only reading the GitGitGadget instructions will not read that far...
Considering your other comment, I think that a little section titled something like
"Anatomy of a patch series" would make sense to introduce how then end product
looks like and then the sections on GGG or git-send-email can reference this earlier section.
Good idea.
Thanks!
Philippe.
[1] https://git-scm.com/docs/MyFirstContribution#single-patch
next prev parent reply other threads:[~2022-04-28 18:26 UTC|newest]
Thread overview: 43+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-27 19:04 [PATCH 0/3] Improve MyFirstContribution's GitGitGadget section Philippe Blain via GitGitGadget
2022-04-27 19:04 ` [PATCH 1/3] MyFirstContribution: move cover letter description to a separate file Philippe Blain via GitGitGadget
2022-04-27 21:15 ` Eric Sunshine
2022-04-27 22:02 ` Philippe Blain
2022-04-27 21:48 ` Junio C Hamano
2022-04-28 18:16 ` Philippe Blain
2022-04-27 19:04 ` [PATCH 2/3] MyFirstContribution: also explain cover letter in GitGitGadget section Philippe Blain via GitGitGadget
2022-04-27 20:43 ` Victoria Dye
2022-04-28 18:21 ` Philippe Blain
2022-04-29 16:27 ` Victoria Dye
2022-05-10 23:45 ` Philippe Blain
2022-04-27 19:04 ` [PATCH 3/3] MyFirstContribution: drop PR description for GGG single-patch contributions Philippe Blain via GitGitGadget
2022-04-27 21:56 ` Junio C Hamano
2022-04-28 18:25 ` Philippe Blain [this message]
2022-04-28 19:43 ` Junio C Hamano
2022-05-11 1:47 ` [PATCH v2 0/5] Improve MyFirstContribution's GitGitGadget section Philippe Blain via GitGitGadget
2022-05-11 1:47 ` [PATCH v2 1/5] MyFirstContribution: add "Anatomy of a Patch Series" section Philippe Blain via GitGitGadget
2022-05-11 6:20 ` Bagas Sanjaya
2022-05-11 21:30 ` Junio C Hamano
2022-05-11 21:48 ` Philippe Blain
2022-05-11 22:09 ` Junio C Hamano
2022-05-12 23:00 ` Philippe Blain
2022-05-12 12:11 ` Philip Oakley
2022-05-12 22:53 ` Philippe Blain
2022-05-11 1:47 ` [PATCH v2 2/5] MyFirstContribution: add standalone section on cover letter Philippe Blain via GitGitGadget
2022-05-11 10:01 ` Junio C Hamano
2022-05-11 21:49 ` Philippe Blain
2022-05-11 1:47 ` [PATCH v2 3/5] MyFirstContribution: reference "The cover letter" in "Preparing Email" Philippe Blain via GitGitGadget
2022-05-11 1:47 ` [PATCH v2 4/5] MyFirstContribution: reference "The cover letter" in GitGitGadget section Philippe Blain via GitGitGadget
2022-05-11 1:47 ` [PATCH v2 5/5] MyFirstContribution: drop PR description for GGG single-patch contributions Philippe Blain via GitGitGadget
2022-05-11 10:11 ` [PATCH v2 0/5] Improve MyFirstContribution's GitGitGadget section Junio C Hamano
2022-05-11 17:45 ` Victoria Dye
2022-05-12 23:43 ` [PATCH v3 " Philippe Blain via GitGitGadget
2022-05-12 23:43 ` [PATCH v3 1/5] MyFirstContribution: add "Anatomy of a Patch Series" section Philippe Blain via GitGitGadget
2022-05-12 23:43 ` [PATCH v3 2/5] MyFirstContribution: add standalone section on cover letter Philippe Blain via GitGitGadget
2022-05-12 23:43 ` [PATCH v3 3/5] MyFirstContribution: reference "The cover letter" in "Preparing Email" Philippe Blain via GitGitGadget
2022-05-12 23:43 ` [PATCH v3 4/5] MyFirstContribution: reference "The cover letter" in GitGitGadget section Philippe Blain via GitGitGadget
2022-05-12 23:43 ` [PATCH v3 5/5] MyFirstContribution: drop PR description for GGG single-patch contributions Philippe Blain via GitGitGadget
2022-05-19 21:49 ` [PATCH v3 0/5] Improve MyFirstContribution's GitGitGadget section Junio C Hamano
2022-05-21 16:17 ` Philippe Blain
2022-05-22 1:35 ` Junio C Hamano
2022-05-24 12:29 ` Philippe Blain
2022-05-24 19:06 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=73b8834b-c2be-7e47-0f77-4853a5a051b7@gmail.com \
--to=levraiphilippeblain@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=emilyshaffer@google.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).