git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] .github/PULL_REQUEST_TEMPLATE.md: add a note about single-commit PRs

From
Philippe Blain <levraiphilippeblain@gmail.com>
Date
Feb 6, 2024, 13:17 UTC
Message-ID
<b7789242-5eee-3b1b-54e7-cafce96f2340@gmail.com>
In-Reply-To
<xmqqsf28oufw.fsf@gitster.g>
Hi Junio,
Le 2024-02-04 à 15:17, Junio C Hamano a écrit :
Show 24 quoted lines
> "Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:
> 
>> diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
>> index 952c7c3a2aa..65fa3a37173 100644
>> --- a/.github/PULL_REQUEST_TEMPLATE.md
>> +++ b/.github/PULL_REQUEST_TEMPLATE.md
>> @@ -4,4 +4,8 @@ a mailing list (git@vger.kernel.org) for code submissions, code reviews, and
>>  bug reports. Nevertheless, you can use GitGitGadget (https://gitgitgadget.github.io/)
>>  to conveniently send your Pull Requests commits to our mailing list.
>>  
>> +If you use Gitgitgadget for a single-commit pull request, please *leave the pull
>> +request description empty*: your commit message itself should describe your
>> +changes.
>> +
>>  Please read the "guidelines for contributing" linked above!
> 
> Making it easier for contributors to come up with the right output
> is greatly appreciated.  I think "If you use Gitgitgadget for" ->
> "For" is probably a good change, for two reasons (one, we do not
> take pull request except for GGG gateway in the first place, and
> two, PR messages being similar to cover letters, you do not want to
> have a detailed PR message that (a) takes extra time to write, (b)
> can duplicate what the you already have written, and (c) could
> contradict what the commit log message says.
Good idea, I'll tweak that in v2.
Show 15 quoted lines
> I wonder if such a rule can be also enforced at the GGG side?  It
> apparently knows if it is dealing with a single-patch request or a
> multi-patch series (as the types of messages this documentation
> update tries to address are the only ones that get duplicates under
> the three-dash line), and I've seen GGG complain on the contents of
> the commit log message (e.g., "not signed off") so there is enough
> support to inspect things in a PR and add instruction to the PR
> discussion.  Unless the machinery GGG uses lack the ability to read
> the PR message (unlike the commit log messages that it can read
> apparently), it may be able to enforce that "for a single patch, PR
> message should be empty" rule before the /submit instruction.  It
> might make things even more helpful if it can notice the commit log
> message is similar enough or superset of PR message and refrain from
> inserting it after the three-dash line, but that might be asking too
> much ;-)

Yes, it probably is possible, and Dscho suggested the same in [1] and [2]. I'll maybe get a crack at it eventually, but I hope in the meantime this simple addition to the PR template will help a bit.

Thanks,
Philippe.

[1] https://github.com/gitgitgadget/gitgitgadget/issues/340#issuecomment-717782054 [2] https://github.com/gitgitgadget/gitgitgadget.github.io/pull/8#issuecomment-1133758832

Previous: Junio C HamanoNext: Junio C Hamano
Message 3 of 5 in “.github/PULL_REQUEST_TEMPLATE.md: add a note about single-commit PRs”
  1. .github/PULL_REQUEST_TEMPLATE.md: add a note about single-commit PRsPhilippe Blain via GitGitGadget, Feb 4, 2024
  2. Junio C HamanoFeb 4, 2024
  3. Philippe BlainFeb 6, 2024
  4. Junio C HamanoFeb 6, 2024
  5. .github/PULL_REQUEST_TEMPLATE.md: add a note about single-commit PRsPhilippe Blain via GitGitGadget, Feb 6, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.