Re: [PATCH 2/3] MyFirstContribution: also explain cover letter in GitGitGadget section

From: Philippe Blain <levraiphilippeblain@gmail.com>
Date: Apr 28, 2022, 18:21 UTC
Message-ID: <c7030c98-bd65-7d0e-89ac-ae291e22b10d@gmail.com>
In-Reply-To: <ed4a0e46-a45c-0b05-fc35-f82e377ea231@github.com>

Hi Victoria,

Le 2022-04-27 à 16:43, Victoria Dye a écrit :

> Philippe Blain via GitGitGadget wrote:

Show 10 quoted lines

>> +----
>> +Adding the 'psuh' command
> 
> Typically I see patch series titles follow the same "imperative mood" as
> commit titles/messages (see 'Documentation/SubmittingPatches.txt'). I'm not
> sure whether that's a rule written down somewhere or just convention, but
> for the sake of consistency you might want to do something like:
> 
> 	"Add the 'psuh' command"
>

I fully agree. I just copied the existing patch series title from the git-send-email section further down. I think it would make sense to change this to also using the imperative mood just like commit messages in a preparatory commit. I'll do that.

Show 10 quoted lines

>> +----
>> +
>> +Your PR's description will used as the body of the cover letter.
> 
> Including the line "Your PR's description..." is somewhat confusing to me as
> a first-time reader, since I was interpreting this section to be the
> *verbatim* text of the pull request title & description. If this *is* meant
> to be that description, then the note about the PR description can be
> removed. That point is also mentioned above, so it's probably not needed
> here anyway.

I'm not exactly sure what you mean. I meant that the description of the PR will be used as the body of the cover letter...

Thanks for having a look!

Philippe.