Merge branch 'jt/namespaced-ls-refs-fix'
[git/git.git] / contrib / hooks / multimail / CONTRIBUTING.rst
1 Contributing
2 ============
3
4 git-multimail is an open-source project, built by volunteers. We would
5 welcome your help!
6
7 The current maintainers are `Matthieu Moy <http://matthieu-moy.fr>`__ and
8 `Michael Haggerty <https://github.com/mhagger>`__.
9
10 Please note that although a copy of git-multimail is distributed in
11 the "contrib" section of the main Git project, development takes place
12 in a separate `git-multimail repository on GitHub`_.
13
14 Whenever enough changes to git-multimail have accumulated, a new
15 code-drop of git-multimail will be submitted for inclusion in the Git
16 project.
17
18 We use the GitHub issue tracker to keep track of bugs and feature
19 requests, and we use GitHub pull requests to exchange patches (though,
20 if you prefer, you can send patches via the Git mailing list with CC
21 to the maintainers). Please sign off your patches as per the `Git
22 project practice
23 <https://github.com/git/git/blob/master/Documentation/SubmittingPatches#L234>`__.
24
25 Please vote for issues you would like to be addressed in priority
26 (click "add your reaction" and then the "+1" thumbs-up button on the
27 GitHub issue).
28
29 General discussion of git-multimail can take place on the main `Git
30 mailing list`_.
31
32 Please CC emails regarding git-multimail to the maintainers so that we
33 don't overlook them.
34
35 Help needed: testers/maintainer for specific environments/OS
36 ------------------------------------------------------------
37
38 The current maintainer uses and tests git-multimail on Linux with the
39 Generic environment. More testers, or better contributors are needed
40 to test git-multimail on other real-life setups:
41
42 * Mac OS X, Windows: git-multimail is currently not supported on these
43 platforms. But since we have no external dependencies and try to
44 write code as portable as possible, it is possible that
45 git-multimail already runs there and if not, it is likely that it
46 could be ported easily.
47
48 Patches to improve support for Windows and OS X are welcome.
49 Ideally, there would be a sub-maintainer for each OS who would test
50 at least once before each release (around twice a year).
51
52 * Gerrit, Stash, Gitolite environments: although the testsuite
53 contains tests for these environments, a tester/maintainer for each
54 environment would be welcome to test and report failure (or success)
55 on real-life environments periodically (here also, feedback before
56 each release would be highly appreciated).
57
58
59 .. _`git-multimail repository on GitHub`: https://github.com/git-multimail/git-multimail
60 .. _`Git mailing list`: git@vger.kernel.org