{"thread":{"id":"60843","subject":"[PATCH] .github/PULL_REQUEST_TEMPLATE.md: add a note about single-commit PRs","startedAt":"2024-02-04T18:03:31Z","lastAt":"2024-02-06T17:56:54Z","messageCount":5,"participants":["Philippe Blain via GitGitGadget","Junio C Hamano","Philippe Blain"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"487897","messageId":"pull.1665.git.git.1707069808205.gitgitgadget@gmail.com","threadId":"60843","inReplyTo":null,"subject":"[PATCH] .github/PULL_REQUEST_TEMPLATE.md: add a note about single-commit PRs","fromName":"Philippe Blain via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-02-04T18:03:28Z","receivedAt":"2024-02-04T18:03:31Z","isPatch":true,"sender":{"key":"levraiphilippeblain@gmail.com","avatar":"https://avatars.githubusercontent.com/u/44212482?v=4"},"body":"From: Philippe Blain <levraiphilippeblain@gmail.com>\n\nContributors using Gitgitgadget continue to send single-commit PRs with\ntheir commit message text duplicated below the three-dash line,\nincreasing the signal-to-noise ratio for reviewers.\n\nThis is because Gitgitgadget copies the pull request description as an\nin-patch commentary, for single-commit PRs, and _GitHub_ defaults to\nprefilling the pull request description with the commit message, for\nsingle-commit PRs (followed by the content of the pull request\ntemplate).\n\nAdd a note in the pull request template mentioning that for\nsingle-commit PRs, the PR description should thus be kept empty, in the\nhope that contributors read it and act on it.\n\nThis partly addresses:\nhttps://github.com/gitgitgadget/gitgitgadget/issues/340\n\nSigned-off-by: Philippe Blain <levraiphilippeblain@gmail.com>\n---\n    .github/PULL_REQUEST_TEMPLATE.md: add a note about single-commit PRs\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1665%2Fphil-blain%2Fempty-description-single-commit-prs-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1665/phil-blain/empty-description-single-commit-prs-v1\nPull-Request: https://github.com/git/git/pull/1665\n\n .github/PULL_REQUEST_TEMPLATE.md | 4 ++++\n 1 file changed, 4 insertions(+)\n\ndiff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md\nindex 952c7c3a2aa..65fa3a37173 100644\n--- a/.github/PULL_REQUEST_TEMPLATE.md\n+++ b/.github/PULL_REQUEST_TEMPLATE.md\n@@ -4,4 +4,8 @@ a mailing list (git@vger.kernel.org) for code submissions, code reviews, and\n bug reports. Nevertheless, you can use GitGitGadget (https://gitgitgadget.github.io/)\n to conveniently send your Pull Requests commits to our mailing list.\n \n+If you use Gitgitgadget for a single-commit pull request, please *leave the pull\n+request description empty*: your commit message itself should describe your\n+changes.\n+\n Please read the \"guidelines for contributing\" linked above!\n\nbase-commit: bc7ee2e5e16f0d1e710ef8fab3db59ab11f2bbe7\n-- \ngitgitgadget\n"},{"id":"487900","messageId":"xmqqsf28oufw.fsf@gitster.g","threadId":"60843","inReplyTo":"pull.1665.git.git.1707069808205.gitgitgadget@gmail.com","subject":"Re: [PATCH] .github/PULL_REQUEST_TEMPLATE.md: add a note about single-commit PRs","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2024-02-04T20:17:39Z","receivedAt":"2024-02-04T20:17:49Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"\"Philippe Blain via GitGitGadget\" <gitgitgadget@gmail.com> writes:\n\n> diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md\n> index 952c7c3a2aa..65fa3a37173 100644\n> --- a/.github/PULL_REQUEST_TEMPLATE.md\n> +++ b/.github/PULL_REQUEST_TEMPLATE.md\n> @@ -4,4 +4,8 @@ a mailing list (git@vger.kernel.org) for code submissions, code reviews, and\n>  bug reports. Nevertheless, you can use GitGitGadget (https://gitgitgadget.github.io/)\n>  to conveniently send your Pull Requests commits to our mailing list.\n>  \n> +If you use Gitgitgadget for a single-commit pull request, please *leave the pull\n> +request description empty*: your commit message itself should describe your\n> +changes.\n> +\n>  Please read the \"guidelines for contributing\" linked above!\n\nMaking it easier for contributors to come up with the right output\nis greatly appreciated.  I think \"If you use Gitgitgadget for\" ->\n\"For\" is probably a good change, for two reasons (one, we do not\ntake pull request except for GGG gateway in the first place, and\ntwo, PR messages being similar to cover letters, you do not want to\nhave a detailed PR message that (a) takes extra time to write, (b)\ncan duplicate what the you already have written, and (c) could\ncontradict what the commit log message says.\n\nI wonder if such a rule can be also enforced at the GGG side?  It\napparently knows if it is dealing with a single-patch request or a\nmulti-patch series (as the types of messages this documentation\nupdate tries to address are the only ones that get duplicates under\nthe three-dash line), and I've seen GGG complain on the contents of\nthe commit log message (e.g., \"not signed off\") so there is enough\nsupport to inspect things in a PR and add instruction to the PR\ndiscussion.  Unless the machinery GGG uses lack the ability to read\nthe PR message (unlike the commit log messages that it can read\napparently), it may be able to enforce that \"for a single patch, PR\nmessage should be empty\" rule before the /submit instruction.  It\nmight make things even more helpful if it can notice the commit log\nmessage is similar enough or superset of PR message and refrain from\ninserting it after the three-dash line, but that might be asking too\nmuch ;-)\n\nThanks for helping to improve the situation.\n\nWill queue.\n\n"},{"id":"488068","messageId":"b7789242-5eee-3b1b-54e7-cafce96f2340@gmail.com","threadId":"60843","inReplyTo":"xmqqsf28oufw.fsf@gitster.g","subject":"Re: [PATCH] .github/PULL_REQUEST_TEMPLATE.md: add a note about single-commit PRs","fromName":"Philippe Blain","fromEmail":"levraiphilippeblain@gmail.com","sentAt":"2024-02-06T13:17:10Z","receivedAt":"2024-02-06T13:17:13Z","isPatch":true,"sender":{"key":"levraiphilippeblain@gmail.com","avatar":"https://avatars.githubusercontent.com/u/44212482?v=4"},"body":"Hi Junio,\n\nLe 2024-02-04 à 15:17, Junio C Hamano a écrit :\n> \"Philippe Blain via GitGitGadget\" <gitgitgadget@gmail.com> writes:\n> \n>> diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md\n>> index 952c7c3a2aa..65fa3a37173 100644\n>> --- a/.github/PULL_REQUEST_TEMPLATE.md\n>> +++ b/.github/PULL_REQUEST_TEMPLATE.md\n>> @@ -4,4 +4,8 @@ a mailing list (git@vger.kernel.org) for code submissions, code reviews, and\n>>  bug reports. Nevertheless, you can use GitGitGadget (https://gitgitgadget.github.io/)\n>>  to conveniently send your Pull Requests commits to our mailing list.\n>>  \n>> +If you use Gitgitgadget for a single-commit pull request, please *leave the pull\n>> +request description empty*: your commit message itself should describe your\n>> +changes.\n>> +\n>>  Please read the \"guidelines for contributing\" linked above!\n> \n> Making it easier for contributors to come up with the right output\n> is greatly appreciated.  I think \"If you use Gitgitgadget for\" ->\n> \"For\" is probably a good change, for two reasons (one, we do not\n> take pull request except for GGG gateway in the first place, and\n> two, PR messages being similar to cover letters, you do not want to\n> have a detailed PR message that (a) takes extra time to write, (b)\n> can duplicate what the you already have written, and (c) could\n> contradict what the commit log message says.\n\nGood idea, I'll tweak that in v2.\n\n\n> I wonder if such a rule can be also enforced at the GGG side?  It\n> apparently knows if it is dealing with a single-patch request or a\n> multi-patch series (as the types of messages this documentation\n> update tries to address are the only ones that get duplicates under\n> the three-dash line), and I've seen GGG complain on the contents of\n> the commit log message (e.g., \"not signed off\") so there is enough\n> support to inspect things in a PR and add instruction to the PR\n> discussion.  Unless the machinery GGG uses lack the ability to read\n> the PR message (unlike the commit log messages that it can read\n> apparently), it may be able to enforce that \"for a single patch, PR\n> message should be empty\" rule before the /submit instruction.  It\n> might make things even more helpful if it can notice the commit log\n> message is similar enough or superset of PR message and refrain from\n> inserting it after the three-dash line, but that might be asking too\n> much ;-)\n\nYes, it probably is possible, and Dscho suggested the same in [1] and [2].\nI'll maybe get a crack at it eventually, but I hope in the meantime this\nsimple addition to the PR template will help a bit.\n\nThanks,\n\nPhilippe.\n\n[1] https://github.com/gitgitgadget/gitgitgadget/issues/340#issuecomment-717782054\n[2] https://github.com/gitgitgadget/gitgitgadget.github.io/pull/8#issuecomment-1133758832\n"},{"id":"488069","messageId":"pull.1665.v2.git.git.1707225612576.gitgitgadget@gmail.com","threadId":"60843","inReplyTo":"pull.1665.git.git.1707069808205.gitgitgadget@gmail.com","subject":"[PATCH v2] .github/PULL_REQUEST_TEMPLATE.md: add a note about single-commit PRs","fromName":"Philippe Blain via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2024-02-06T13:20:12Z","receivedAt":"2024-02-06T13:20:15Z","isPatch":true,"sender":{"key":"levraiphilippeblain@gmail.com","avatar":"https://avatars.githubusercontent.com/u/44212482?v=4"},"body":"From: Philippe Blain <levraiphilippeblain@gmail.com>\n\nContributors using Gitgitgadget continue to send single-commit PRs with\ntheir commit message text duplicated below the three-dash line,\nincreasing the signal-to-noise ratio for reviewers.\n\nThis is because Gitgitgadget copies the pull request description as an\nin-patch commentary, for single-commit PRs, and _GitHub_ defaults to\nprefilling the pull request description with the commit message, for\nsingle-commit PRs (followed by the content of the pull request\ntemplate).\n\nAdd a note in the pull request template mentioning that for\nsingle-commit PRs, the PR description should thus be kept empty, in the\nhope that contributors read it and act on it.\n\nThis partly addresses:\nhttps://github.com/gitgitgadget/gitgitgadget/issues/340\n\nSigned-off-by: Philippe Blain <levraiphilippeblain@gmail.com>\n---\n    .github/PULL_REQUEST_TEMPLATE.md: add a note about single-commit PRs\n    \n    Changes since v1:\n    \n     * simplified the wording as suggested by Junio\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1665%2Fphil-blain%2Fempty-description-single-commit-prs-v2\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1665/phil-blain/empty-description-single-commit-prs-v2\nPull-Request: https://github.com/git/git/pull/1665\n\nRange-diff vs v1:\n\n 1:  4786f84884a ! 1:  f719e11b1df .github/PULL_REQUEST_TEMPLATE.md: add a note about single-commit PRs\n     @@ .github/PULL_REQUEST_TEMPLATE.md: a mailing list (git@vger.kernel.org) for code\n       bug reports. Nevertheless, you can use GitGitGadget (https://gitgitgadget.github.io/)\n       to conveniently send your Pull Requests commits to our mailing list.\n       \n     -+If you use Gitgitgadget for a single-commit pull request, please *leave the pull\n     -+request description empty*: your commit message itself should describe your\n     -+changes.\n     ++For a single-commit pull request, please *leave the pull request description\n     ++empty*: your commit message itself should describe your changes.\n      +\n       Please read the \"guidelines for contributing\" linked above!\n\n\n .github/PULL_REQUEST_TEMPLATE.md | 3 +++\n 1 file changed, 3 insertions(+)\n\ndiff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md\nindex 952c7c3a2aa..37654cdfd7a 100644\n--- a/.github/PULL_REQUEST_TEMPLATE.md\n+++ b/.github/PULL_REQUEST_TEMPLATE.md\n@@ -4,4 +4,7 @@ a mailing list (git@vger.kernel.org) for code submissions, code reviews, and\n bug reports. Nevertheless, you can use GitGitGadget (https://gitgitgadget.github.io/)\n to conveniently send your Pull Requests commits to our mailing list.\n \n+For a single-commit pull request, please *leave the pull request description\n+empty*: your commit message itself should describe your changes.\n+\n Please read the \"guidelines for contributing\" linked above!\n\nbase-commit: bc7ee2e5e16f0d1e710ef8fab3db59ab11f2bbe7\n-- \ngitgitgadget\n"},{"id":"488079","messageId":"xmqqttmliihq.fsf@gitster.g","threadId":"60843","inReplyTo":"b7789242-5eee-3b1b-54e7-cafce96f2340@gmail.com","subject":"Re: [PATCH] .github/PULL_REQUEST_TEMPLATE.md: add a note about single-commit PRs","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2024-02-06T17:56:49Z","receivedAt":"2024-02-06T17:56:54Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Philippe Blain <levraiphilippeblain@gmail.com> writes:\n\n> Yes, it probably is possible, and Dscho suggested the same in [1] and [2].\n\nAh, great minds think alike, and Dscho's suggestion was made a few\nyears ago already.\n\n> I'll maybe get a crack at it eventually, but I hope in the meantime this\n> simple addition to the PR template will help a bit.\n\nPerhaps.\n"}]}