Skip to content

Commit 8d26c4b

Browse files
dschodscho
authored
Merge pull request #5 from phil-blain/mention-git-git
Mention using GGG on github.com/git/git
2 parents 5f1cdc2 + a5443fa commit 8d26c4b

File tree

1 file changed

+118
-8
lines changed

1 file changed

+118
-8
lines changed

‎index.html

Lines changed: 118 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,51 @@
2727
tiny {
2828
font-size: 70%;
2929
}
30+
.tg {
31+
border-collapse: collapse;
32+
border-spacing: 0;
33+
margin: 0px auto;
34+
}
35+
.tg td {
36+
padding: 10px 5px;
37+
border-style: solid;
38+
border-width: 1px;
39+
overflow: hidden;
40+
word-break: normal;
41+
border-color: black;
42+
}
43+
.tg th {
44+
font-weight: bold;
45+
padding: 10px 5px;
46+
border-style: solid;
47+
border-width: 1px;
48+
overflow: hidden;
49+
word-break: normal;
50+
border-color: black;
51+
}
52+
.tg .tg-baqh {
53+
width: 15%;
54+
text-align: center;
55+
vertical-align: center;
56+
}
57+
.tg .tg-0lax {
58+
width: 70%;
59+
text-align: left;
60+
vertical-align: center;
61+
}
62+
@media screen and (max-width: 767px) {
63+
.tg {
64+
width: auto !important;
65+
}
66+
.tg col {
67+
width: auto !important;
68+
}
69+
.tg-wrap {
70+
overflow-x: auto;
71+
-webkit-overflow-scrolling: touch;
72+
margin: auto 0px;
73+
}
74+
}
3075
</style>
3176
</head>
3277
<body>
@@ -44,8 +89,8 @@
4489
</p><p>
4590
Apart from lacking the convenience of a web interface, this process also puts considerable demands on the code contributions: the mails are expected to be plain text only (no HTML!), for example, and the diffs embedded in the mails must apply cleanly (no whitespace changes!), among other things.
4691
</p><p>
47-
A few tutorials out there try to help with this process (e.g. <a href="https://github.com/git-for-windows/git/blob/master/CONTRIBUTING.md">Git for Windows' detailed instructions how to contribute patches to the Git project</a>).
48-
GitGitGadget tries a different approach: allow contributing patches to the Git project itself by opening a Pull Request at <a href="https://github.com/gitgitgadget/git">https://github.com/gitgitgadget/git</a> and let GitGitGadget prepare and send the corresponding mails.
92+
A few tutorials out there try to help with this process (e.g. <a href="https://github.com/git-for-windows/git/blob/master/CONTRIBUTING.md">Git for Windows' detailed instructions how to contribute patches to the Git project</a>, or Git's <a href="https://git-scm.com/docs/MyFirstContribution">MyFirstContribution tutorial</a>).
93+
GitGitGadget tries a different approach: allow contributing patches to the Git project itself by opening a Pull Request either at <a href="https://github.com/gitgitgadget/git">https://github.com/gitgitgadget/git</a> or directly at <a href="https://github.com/gitgitgadget/git">https://github.com/git/git</a> and let GitGitGadget prepare and send the corresponding mails.
4994
</p>
5095
</div>
5196

@@ -54,16 +99,21 @@ <h2>How can you use GitGitGadget?</h2>
5499
<p>
55100
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?
56101
And you already pushed it to your own fork?
57-
Good, now is the time to direct your web browser to <a href="https://github.com/gitgitgadget/git">https://github.com/gitgitgadget/git</a> and to open a Pull Request.
58-
Please make sure to use a descriptive Pull Request title and description; GitGitGadget will use these as the cover letter.
59-
You will also want to read <a href="https://git-scm.com/docs/SubmittingPatches">Git's guidelines</a> to make sure that your contributions are in the expected form.
102+
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/gitgitgadget/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>
107+
</p><p>
108+
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>.
109+
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>.
60110
</p><p>
61111
The first time you use GitGitGadget, you need to be added to the list of users with permission to use GitGitGadget (this is a <i>very</i> simple anti-spam measure).
62-
Any user who is already on that list can do that, by adding a comment to that Pull Request that says <tt>/allow &lt;username&gt;</name></tt> (with your GitHub login name).
112+
Any user who is already on that list can do that, by adding a comment to that Pull Request that says <code>/allow &lt;username&gt;</name></code> (with your GitHub login name).
63113
</p><p>
64114
The Pull Request will trigger a few Checks, most importantly one that will build Git and run the test suite on the main platforms, to make sure that everything works as advertised.
65115
</p><p>
66-
Once everything is ready to go, add a comment to that Pull Request saying <tt>/submit</tt>.
116+
Once everything is ready to go, add a comment to that Pull Request saying <code>/submit</code>.
67117
This will trigger GitGitGadget (you can see the progress via the Check called "GitGitGadget PR Handler"): it will wrap your Pull Request into a nice bundle of mails in the format expected on the Git mailing list.
68118
</p>
69119
</div>
@@ -75,8 +125,68 @@ <h2>What happens after GitGitGadget sent the mails?</h2>
75125
The Git developer community is globally distributed, so please wait a day or two for reviewer comments to trickle in before sending another iteration of your patch series (if needed).
76126
</p><p>
77127
In the case that a reviewer asks for changes, you should respond either acknowledging that you will make those changes or making an argument against the requested changes.
78-
If your patches need to be revised, please use <tt>git rebase -i</tt> to do that, then force-push, then update the description of the Pull Request by adding a summary of the changes you made, and then issue another <tt>/submit</tt>.
128+
If your patches need to be revised, please use <code>git rebase -i</code> to do that, then force-push, then update the description of the Pull Request by adding a summary of the changes you made, and then issue another <code>/submit</code>.
129+
</p>
130+
</div>
131+
132+
<h2>Should I use GitGitGadget on GitGitGadget's Git fork or on Git's GitHub mirror?</h2>
133+
<div class="block">
134+
<p>
135+
GitGitGadget works on both GitGitGadget's Git fork (<a href="https://github.com/gitgitgadget/git">https://github.com/gitgitgadget/git</a>) and Git's GitHub mirror (<a href="https://github.com/gitgitgadget/git">https://github.com/git/git</a>).
136+
However, some functionality is only available when opening a PR on GitGitGadget's Git fork.
79137
</p>
138+
<div class="tg-wrap"><table class="tg">
139+
<tr>
140+
<th class="tg-0lax">Features</th>
141+
<th class="tg-baqh"><a href="https://github.com/gitgitgadget/git">gitgitgadget/git</a></th>
142+
<th class="tg-baqh"><a href="https://github.com/git/git">git/git</a></th>
143+
</tr>
144+
<tr>
145+
<td class="tg-0lax">Mirrors emails answers as PR comments</td>
146+
<td class="tg-baqh">✓</td>
147+
<td class="tg-baqh">✓</td>
148+
</tr>
149+
<tr>
150+
<td class="tg-0lax">Mirrors PR comments as emails to the list</td>
151+
<td class="tg-baqh">✗</td>
152+
<td class="tg-baqh">✗</td>
153+
</tr>
154+
<tr>
155+
<td class="tg-0lax">Builds Git and runs the test suite on Linux, macOS, Windows and FreeBSD</td>
156+
<td class="tg-baqh">✓</td>
157+
<td class="tg-baqh">✓</td>
158+
</tr>
159+
<tr>
160+
<td class="tg-0lax">Comments on the PR when a topic branch is created in the <a href="https://github.com/gitster/git/branches">maintainer's fork</a></td>
161+
<td class="tg-baqh">✓</td>
162+
<td class="tg-baqh">✓</td>
163+
</tr>
164+
<tr>
165+
<td class="tg-0lax">Comments on the PR when the series is integrated into <code>pu</code>, <code>next</code>, <code>master</code> and <code>maint</code></td>
166+
<td class="tg-baqh">✓</td>
167+
<td class="tg-baqh">✓</td>
168+
</tr>
169+
<tr>
170+
<td class="tg-0lax">Adds a label to the PR when the series is integrated into <code>pu</code>, <code>next</code>, <code>master</code> and <code>maint</code></td>
171+
<td class="tg-baqh">✓</td>
172+
<td class="tg-baqh">✓</td>
173+
</tr>
174+
<tr>
175+
<td class="tg-0lax">PRs can target <code>pu</code>, <code>next</code>, <code>master</code> and <code>maint</code></td>
176+
<td class="tg-baqh">✓</td>
177+
<td class="tg-baqh">✓</td>
178+
</tr>
179+
<tr>
180+
<td class="tg-0lax">PRs can target any topic branch in the maintainer's fork, as well as <a href="https://github.com/prati0100/git-gui"><code>git-gui/master</code></a></td>
181+
<td class="tg-baqh">✓</td>
182+
<td class="tg-baqh">✗</td>
183+
</tr>
184+
<tr>
185+
<td class="tg-0lax">Creates a direct link between the last commit of the series and the corresponding commit in the "most upstream" integration branch as a GitHub check</td>
186+
<td class="tg-baqh">✓</td>
187+
<td class="tg-baqh">✗</td>
188+
</tr>
189+
</table></div>
80190
</div>
81191

82192
<h2>But... what <i>is</i> GitGitGadget?</h2>

0 commit comments

Comments
 (0)