Skip to content

Commit ff6f0f1

Browse files
authored
Merge pull request #8 from phil-blain/single-patch-pr
Instruct readers to drop PR description for single commit PRs
2 parents e90de4d + b504bc3 commit ff6f0f1

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

.gitattributes

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
.gitattributes eol=lf
2-
*.html eol=lf
2+
*.html eol=lf diff=html
33
*.svg eol=lf
44
*.png binary

index.html

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,14 @@ <h2>How can you use GitGitGadget?</h2>
100100
So you cloned <a href="https://github.com/git/git">https://github.com/git/git</a> and implemented a bug fix or a new feature?
101101
And you already pushed it to your own fork?
102102
Good, now is the time to direct your web browser to <a href="https://github.com/gitgitgadget/git">https://github.com/gitgitgadget/git</a> (or to <a href="https://github.com/git/git">https://github.com/git/git</a> ) and to open a Pull Request.
103-
Please make sure to use a descriptive Pull Request title and description; GitGitGadget will use these as the subject and body of the cover letter (check out the <a href="https://git-scm.com/docs/MyFirstContribution">MyFirstContribution</a> tutorial if you are not familiar with this terminology).
104-
You can CC potential reviewers by adding a footer to the PR description with the following syntax:
105-
</p><p>
106-
<code>CC: Revi Ewer &lt;[email protected]&gt;, Ill Takalook &lt;[email protected]&gt;</code>
103+
A few things to note about a GitGitGadget Pull Request:
104+
<ul>
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 <a href="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>
107+
<li>You can CC potential reviewers by adding a footer to the PR description with the following syntax:</br>
108+
<code>CC: Revi Ewer &lt;[email protected]&gt;, Ill Takalook &lt;[email protected]&gt;</code>
109+
</li>
110+
</ul>
107111
</p><p>
108112
You will also want to read <a href="https://git-scm.com/docs/SubmittingPatches">Git's contribution guidelines</a> to make sure that your contributions are in the expected form, as well as the project's <a href="https://github.com/git/git/blob/master/Documentation/CodingGuidelines">coding guidelines</a>.
109113
You might also want to read the <a href="https://git-scm.com/docs/gitworkflows">gitworkflows</a> manual page to understand how your contributions will be integrated in Git's repository, as well as <a href="https://github.com/git/git/blob/todo/MaintNotes">this note from Git's maintainer</a>.

0 commit comments

Comments
 (0)