2017-06-13 08:18:07 +00:00
|
|
|
## Contributing to Git
|
|
|
|
|
|
|
|
|
|
Thanks for taking the time to contribute to Git! Please be advised that the
|
|
|
|
|
Git community does not use github.com for their contributions. Instead, we use
|
|
|
|
|
a mailing list (git@vger.kernel.org) for code submissions, code
|
|
|
|
|
reviews, and bug reports.
|
|
|
|
|
|
point pull requesters to GitGitGadget
In the contributing guide and PR template seen by people who open pull
requests on GitHub, we mention the submitGit tool, which gives an
alternative to figuring out the mailing list. These days we also have
the similar GitGitGadget tool, and we should make it clear that this
is also an option.
We could continue to mention _both_ tools, but it's probably better to
pick one in order to avoid overwhelming the user with choice. After all,
one of the purposes here is to reduce friction for first-time or
infrequent contributors. And there are a few reasons to prefer GGG:
1. submitGit seems to still have a few rough edges. E.g., it doesn't
munge timestamps to help threaded mail readers handled out-of-order
delivery.
2. Subjectively, GGG seems to be more commonly used on the list these
days, especially by list regulars.
3. GGG seems to be under more active development (likely related to
point 2).
So let's actually swap out submitGit for GGG. While we're there, let's
put another link to the GGG page in the PR template, because that's
where users who are learning about it for the first time will want to go
to read more.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2019-03-12 21:32:46 +00:00
|
|
|
Nevertheless, you can use [GitGitGadget](https://gitgitgadget.github.io/) to
|
2017-06-13 08:18:07 +00:00
|
|
|
conveniently send your Pull Requests commits to our mailing list.
|
|
|
|
|
|
|
|
|
|
Please read ["A note from the maintainer"](https://git.kernel.org/pub/scm/git/git.git/plain/MaintNotes?h=todo)
|
|
|
|
|
to learn how the Git project is managed, and how you can work with it.
|
|
|
|
|
In addition, we highly recommend you to read [our submission guidelines](../Documentation/SubmittingPatches).
|
|
|
|
|
|
|
|
|
|
If you prefer video, then [this talk](https://www.youtube.com/watch?v=Q7i_qQW__q4&feature=youtu.be&t=6m4s)
|
|
|
|
|
might be useful to you as the presenter walks you through the contribution
|
|
|
|
|
process by example.
|
|
|
|
|
|
2020-06-08 21:11:32 +00:00
|
|
|
Or, you can follow the ["My First Contribution"](https://git-scm.com/docs/MyFirstContribution)
|
|
|
|
|
tutorial for another example of the contribution process.
|
|
|
|
|
|
2017-06-13 08:18:07 +00:00
|
|
|
Your friendly Git community!
|