contrib / hooks / multimail / CONTRIBUTING.rston commit Merge branch 'ab/send-email-transferencoding-fix' (86d2271)
   1Contributing
   2============
   3
   4git-multimail is an open-source project, built by volunteers. We would
   5welcome your help!
   6
   7The current maintainers are `Matthieu Moy <http://matthieu-moy.fr>`__ and
   8`Michael Haggerty <https://github.com/mhagger>`__.
   9
  10Please note that although a copy of git-multimail is distributed in
  11the "contrib" section of the main Git project, development takes place
  12in a separate `git-multimail repository on GitHub`_.
  13
  14Whenever enough changes to git-multimail have accumulated, a new
  15code-drop of git-multimail will be submitted for inclusion in the Git
  16project.
  17
  18We use the GitHub issue tracker to keep track of bugs and feature
  19requests, and we use GitHub pull requests to exchange patches (though,
  20if you prefer, you can send patches via the Git mailing list with CC
  21to the maintainers). Please sign off your patches as per the `Git
  22project practice
  23<https://github.com/git/git/blob/master/Documentation/SubmittingPatches#L234>`__.
  24
  25Please 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
  27GitHub issue).
  28
  29General discussion of git-multimail can take place on the main `Git
  30mailing list`_.
  31
  32Please CC emails regarding git-multimail to the maintainers so that we
  33don't overlook them.
  34
  35Help needed: testers/maintainer for specific environments/OS
  36------------------------------------------------------------
  37
  38The current maintainer uses and tests git-multimail on Linux with the
  39Generic environment. More testers, or better contributors are needed
  40to 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