From 05d23d66923664ad92f91de6a7c204ae52024661 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Tue, 17 Mar 2020 08:56:35 -0400 Subject: [PATCH 01/10] Intro: mention MyFirstContribution tutorial --- index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.html b/index.html index 8e2d501c..3f888cb3 100644 --- a/index.html +++ b/index.html @@ -44,7 +44,7 @@

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.

- A few tutorials out there try to help with this process (e.g. Git for Windows' detailed instructions how to contribute patches to the Git project). + A few tutorials out there try to help with this process (e.g. Git for Windows' detailed instructions how to contribute patches to the Git project, or Git's MyFirstContribution tutorial). GitGitGadget tries a different approach: allow contributing patches to the Git project itself by opening a Pull Request at https://github.com/gitgitgadget/git and let GitGitGadget prepare and send the corresponding mails.

From 4d6cd56381b675f7493068dd75d103392511a193 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Tue, 17 Mar 2020 09:03:00 -0400 Subject: [PATCH 02/10] Mention that GGG can also be used on github.com/git/git --- index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/index.html b/index.html index 3f888cb3..8a2de869 100644 --- a/index.html +++ b/index.html @@ -45,7 +45,7 @@ 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.

A few tutorials out there try to help with this process (e.g. Git for Windows' detailed instructions how to contribute patches to the Git project, or Git's MyFirstContribution tutorial). - GitGitGadget tries a different approach: allow contributing patches to the Git project itself by opening a Pull Request at https://github.com/gitgitgadget/git and let GitGitGadget prepare and send the corresponding mails. + GitGitGadget tries a different approach: allow contributing patches to the Git project itself by opening a Pull Request either at https://github.com/gitgitgadget/git or directly at https://github.com/git/git and let GitGitGadget prepare and send the corresponding mails.

@@ -54,7 +54,7 @@

How can you use GitGitGadget?

So you cloned https://github.com/git/git and implemented a bug fix or a new feature? And you already pushed it to your own fork? - Good, now is the time to direct your web browser to https://github.com/gitgitgadget/git and to open a Pull Request. + Good, now is the time to direct your web browser to https://github.com/gitgitgadget/git (or to https://github.com/git/git ) and to open a Pull Request. Please make sure to use a descriptive Pull Request title and description; GitGitGadget will use these as the cover letter. You will also want to read Git's guidelines to make sure that your contributions are in the expected form.

From 69c61528a113c67fce2cca2b9ca63a0e4ec7e1c5 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Tue, 17 Mar 2020 09:04:51 -0400 Subject: [PATCH 03/10] Using: mention CC syntax --- index.html | 3 +++ 1 file changed, 3 insertions(+) diff --git a/index.html b/index.html index 8a2de869..3d2bc89f 100644 --- a/index.html +++ b/index.html @@ -56,6 +56,9 @@

How can you use GitGitGadget?

And you already pushed it to your own fork? Good, now is the time to direct your web browser to https://github.com/gitgitgadget/git (or to https://github.com/git/git ) and to open a Pull Request. Please make sure to use a descriptive Pull Request title and description; GitGitGadget will use these as the cover letter. + You can CC potential reviewers by adding a footer to the PR description with the following syntax: + 
CC: Revi Ewer <revi.ewer@some.domain>, Ill Takalook <ill.takalook@other.domain>
+

You will also want to read Git's guidelines to make sure that your contributions are in the expected form.

The first time you use GitGitGadget, you need to be added to the list of users with permission to use GitGitGadget (this is a very simple anti-spam measure). From ec43d515e05badb9bdd357d1e41e51e8358ce574 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Tue, 17 Mar 2020 09:07:37 -0400 Subject: [PATCH 04/10] Using: add pointers to CodingGuidelines, gitworkflows, MaintNotes --- index.html | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/index.html b/index.html index 3d2bc89f..a1573fc1 100644 --- a/index.html +++ b/index.html @@ -59,7 +59,8 @@

How can you use GitGitGadget?

You can CC potential reviewers by adding a footer to the PR description with the following syntax: 
CC: Revi Ewer <revi.ewer@some.domain>, Ill Takalook <ill.takalook@other.domain>

- You will also want to read Git's guidelines to make sure that your contributions are in the expected form. + You will also want to read Git's contribution guidelines to make sure that your contributions are in the expected form, as well as the project's coding guidelines. + You might also want to read the gitworkflows manual page to understand how your contributions will be integrated in Git's repository, as well as this note from Git's maintainer.

The first time you use GitGitGadget, you need to be added to the list of users with permission to use GitGitGadget (this is a very simple anti-spam measure). Any user who is already on that list can do that, by adding a comment to that Pull Request that says /allow <username> (with your GitHub login name). From 32cb86cb027b2824dbbe973e34d9d3fcaf089f14 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Tue, 17 Mar 2020 09:23:01 -0400 Subject: [PATCH 05/10] Add a section comparing using GGG on GGG's Git fork and github.com/git/git --- index.html | 105 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 105 insertions(+) diff --git a/index.html b/index.html index a1573fc1..22c2dcb0 100644 --- a/index.html +++ b/index.html @@ -27,6 +27,51 @@ tiny { font-size: 70%; } + .tg { + border-collapse: collapse; + border-spacing: 0; + margin: 0px auto; + } + .tg td { + padding: 10px 5px; + border-style: solid; + border-width: 1px; + overflow: hidden; + word-break: normal; + border-color: black; + } + .tg th { + font-weight: bold; + padding: 10px 5px; + border-style: solid; + border-width: 1px; + overflow: hidden; + word-break: normal; + border-color: black; + } + .tg .tg-baqh { + width: 15%; + text-align: center; + vertical-align: center; + } + .tg .tg-0lax { + width: 70%; + text-align: left; + vertical-align: center; + } + @media screen and (max-width: 767px) { + .tg { + width: auto !important; + } + .tg col { + width: auto !important; + } + .tg-wrap { + overflow-x: auto; + -webkit-overflow-scrolling: touch; + margin: auto 0px; + } + } @@ -83,6 +128,66 @@

What happens after GitGitGadget sent the mails?

+

Should I use GitGitGadget on GitGitGadget's Git fork or on Git's GitHub mirror?

+
+

+ GitGitGadget works on both GitGitGadget's Git fork (https://github.com/gitgitgadget/git) and Git's GitHub mirror (https://github.com/git/git). + However, some functionality is only available when opening a PR on GitGitGadget's Git fork. +

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Featuresgitgitgadget/gitgit/git
Mirror emails answers as PR comments✅✅
Mirror PR comments as emails to the list❌❌
Build Git and run the test suite on Linux, macOS, Windows and FreeBSD✅✅
Comment on the PR when a topic branch is created in the maintainer's fork✅✅
Comment on the PR when the series is integrated into pu, next, master and maint✅✅
Add a label to the PR when the series is integrated into pu, next, master and maint✅✅
Target pu, next, master and maint✅✅
Target any topic branch in the maintainer's fork, as well as git-gui/master✅❌
Get a direct link between the last commit of the series and the corresponding commit in the "most upstream" integration branch as a GitHub check✅❌
+
+

But... what is GitGitGadget?

From 6c6149a959c2dd2a5e22335062325f60a2f35288 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Thu, 19 Mar 2020 18:15:58 -0400 Subject: [PATCH 06/10] Use tag instead of deprecated --- index.html | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/index.html b/index.html index 22c2dcb0..8c0327a2 100644 --- a/index.html +++ b/index.html @@ -108,11 +108,11 @@

How can you use GitGitGadget?

You might also want to read the gitworkflows manual page to understand how your contributions will be integrated in Git's repository, as well as this note from Git's maintainer.

The first time you use GitGitGadget, you need to be added to the list of users with permission to use GitGitGadget (this is a very simple anti-spam measure). - Any user who is already on that list can do that, by adding a comment to that Pull Request that says /allow <username> (with your GitHub login name). + Any user who is already on that list can do that, by adding a comment to that Pull Request that says /allow <username> (with your GitHub login name).

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.

- Once everything is ready to go, add a comment to that Pull Request saying /submit. + Once everything is ready to go, add a comment to that Pull Request saying /submit. 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.

@@ -124,7 +124,7 @@

What happens after GitGitGadget sent the mails?

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).

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. - If your patches need to be revised, please use git rebase -i 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 /submit. + If your patches need to be revised, please use git rebase -i 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 /submit.

@@ -161,22 +161,22 @@

Should I use GitGitGadget on GitGitGadget's Git fork or on Git's GitHub mirr ✅ - Comment on the PR when the series is integrated into pu, next, master and maint + Comment on the PR when the series is integrated into pu, next, master and maint ✅ ✅ - Add a label to the PR when the series is integrated into pu, next, master and maint + Add a label to the PR when the series is integrated into pu, next, master and maint ✅ ✅ - Target pu, next, master and maint + Target pu, next, master and maint ✅ ✅ - Target any topic branch in the maintainer's fork, as well as git-gui/master + Target any topic branch in the maintainer's fork, as well as git-gui/master ✅ ❌ From 828bf9dcdb4c054fcf916d78a8ba6a777d15e2d2 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Thu, 19 Mar 2020 18:24:24 -0400 Subject: [PATCH 07/10] Using: add a pointer about the cover letter --- index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.html b/index.html index 8c0327a2..c537c9ae 100644 --- a/index.html +++ b/index.html @@ -100,7 +100,7 @@

How can you use GitGitGadget?

So you cloned https://github.com/git/git and implemented a bug fix or a new feature? And you already pushed it to your own fork? Good, now is the time to direct your web browser to https://github.com/gitgitgadget/git (or to https://github.com/git/git ) and to open a Pull Request. - Please make sure to use a descriptive Pull Request title and description; GitGitGadget will use these as the cover letter. + 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 MyFirstContribution tutorial if you are not familiar with this terminology). You can CC potential reviewers by adding a footer to the PR description with the following syntax: 
CC: Revi Ewer <revi.ewer@some.domain>, Ill Takalook <ill.takalook@other.domain>

From 013bf33e3bfdbc3fb6f3796fc7ed42d7182545f4 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Thu, 19 Mar 2020 18:28:10 -0400 Subject: [PATCH 08/10] Features: use monochrome checks and x's --- index.html | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/index.html b/index.html index c537c9ae..ec617374 100644 --- a/index.html +++ b/index.html @@ -142,48 +142,48 @@

Should I use GitGitGadget on GitGitGadget's Git fork or on Git's GitHub mirr Mirror emails answers as PR comments - ✅ - ✅ + ✓ + ✓ Mirror PR comments as emails to the list - ❌ - ❌ + ✗ + ✗ Build Git and run the test suite on Linux, macOS, Windows and FreeBSD - ✅ - ✅ + ✓ + ✓ Comment on the PR when a topic branch is created in the maintainer's fork - ✅ - ✅ + ✓ + ✓ Comment on the PR when the series is integrated into pu, next, master and maint - ✅ - ✅ + ✓ + ✓ Add a label to the PR when the series is integrated into pu, next, master and maint - ✅ - ✅ + ✓ + ✓ Target pu, next, master and maint - ✅ - ✅ + ✓ + ✓ Target any topic branch in the maintainer's fork, as well as git-gui/master - ✅ - ❌ + ✓ + ✗ Get a direct link between the last commit of the series and the corresponding commit in the "most upstream" integration branch as a GitHub check - ✅ - ❌ + ✓ + ✗ From 58b623b9b15627a301c39e64e3aa089573408c74 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Thu, 19 Mar 2020 18:40:43 -0400 Subject: [PATCH 09/10] Features: use 3rd person --- index.html | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/index.html b/index.html index ec617374..978f3ee5 100644 --- a/index.html +++ b/index.html @@ -141,47 +141,47 @@

Should I use GitGitGadget on GitGitGadget's Git fork or on Git's GitHub mirr git/git - Mirror emails answers as PR comments + Mirrors emails answers as PR comments ✓ ✓ - Mirror PR comments as emails to the list + Mirrors PR comments as emails to the list ✗ ✗ - Build Git and run the test suite on Linux, macOS, Windows and FreeBSD + Builds Git and runs the test suite on Linux, macOS, Windows and FreeBSD ✓ ✓ - Comment on the PR when a topic branch is created in the maintainer's fork + Comments on the PR when a topic branch is created in the maintainer's fork ✓ ✓ - Comment on the PR when the series is integrated into pu, next, master and maint + Comments on the PR when the series is integrated into pu, next, master and maint ✓ ✓ - Add a label to the PR when the series is integrated into pu, next, master and maint + Adds a label to the PR when the series is integrated into pu, next, master and maint ✓ ✓ - Target pu, next, master and maint + PRs can target pu, next, master and maint ✓ ✓ - Target any topic branch in the maintainer's fork, as well as git-gui/master + PRs can target any topic branch in the maintainer's fork, as well as git-gui/master ✓ ✗ - Get a direct link between the last commit of the series and the corresponding commit in the "most upstream" integration branch as a GitHub check + 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 ✓ ✗ From a5443fa04e310a274c0b154a53a796be1a20f538 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Thu, 19 Mar 2020 18:45:58 -0400 Subject: [PATCH 10/10] Use instead of 

---
 index.html | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/index.html b/index.html
index 978f3ee5..ff58d7cf 100644
--- a/index.html
+++ b/index.html
@@ -102,7 +102,8 @@ 
How can you use GitGitGadget?

 				Good, now is the time to direct your web browser to https://github.com/gitgitgadget/git (or to https://github.com/git/git ) and to open a Pull Request.
 				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 MyFirstContribution tutorial if you are not familiar with this terminology).
 				You can CC potential reviewers by adding a footer to the PR description with the following syntax:
-				
CC: Revi Ewer <revi.ewer@some.domain>, Ill Takalook <ill.takalook@other.domain>

+			

+				CC: Revi Ewer <revi.ewer@some.domain>, Ill Takalook <ill.takalook@other.domain>
 			

 				You will also want to read Git's contribution guidelines to make sure that your contributions are in the expected form, as well as the project's coding guidelines.
 				You might also want to read the gitworkflows manual page to understand how your contributions will be integrated in Git's repository, as well as this note from Git's maintainer.