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. A few things to note about a GitGitGadget Pull Request:

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 MyFirstContribution tutorial if you are not familiar with this terminology).

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.

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 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). Using IRC or PRs you can find a user already on this list and request them to add you to the list. To do so, they simply have to add a comment to that Pull Request that says /allow.

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 you feel everything is ready to go, add a comment to that Pull Request saying /preview. This will send you a copy of the Pull Request to check. Once you are happy with the result, 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.

What happens after GitGitGadget sent the mails? #

The patches will be reviewed by volunteers (be gentle…) and you will most likely receive helpful comments. 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.

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.

But… what is GitGitGadget? #

GitGitGadget itself is a GitHub App that is backed by an Azure Function written in pure Javascript which in turn triggers an Azure Pipeline written in Typescript (which is really easy to understand and write for everybody who knows even just a little Javascript), maintained at https://github.com/gitgitgadget/gitgitgadget.