You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Using GGG: instruct to drop description for single-commit PRs
For single commit PRs, GitHub prepends the commit message to the PR
description, before the PR template.
Contributors will then (hopefully) remove the template and keep the rest
of the description. Since the PR description is added as an in-patch
commentary for single-commit PRs, the same text appears twice in the
generatred email (once in the commit messge and once in the in-patch
commentary), decreasing the signal-to-noise ratio for reviewers.
Let's instruct readers to empty the PR description for single commit
PRs.
This partly addresses:
gitgitgadget/gitgitgadget#340
Copy file name to clipboardExpand all lines: index.html
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -103,6 +103,7 @@ <h2>How can you use GitGitGadget?</h2>
103
103
A few things to note about a GitGitGadget Pull Request:
104
104
<ul>
105
105
<li>Please make sure to use a descriptive title and description; GitGitGadget will use these as the subject and body of the cover letter (check out the <ahref="https://git-scm.com/docs/MyFirstContribution#cover-letter">MyFirstContribution</a> tutorial if you are not familiar with this terminology).</li>
106
+
<li>If your pull request consist of a single commit, leave the pull request description empty, as your commit message itself should be enough to explain the rationale for your changes.</li>
106
107
<li>You can CC potential reviewers by adding a footer to the PR description with the following syntax:</br>
0 commit comments