From 6dcd69174d3c0258bf525ee2a7e184b30fad0fd3 Mon Sep 17 00:00:00 2001 From: Mike Burns Date: Wed, 19 Mar 2014 17:44:50 +0100 Subject: Generate the list of contributors from git Instead of requiring contributors to update rcm(7), pull the list of contributors from the git log instead. The `rcm.7` file has been moved to `rcm.7.mustache`. The `autogen.sh` command will write `rcm.7` using autocontrib, a quick script included in this commit. This commit adds a `.mailmap` file, used by git-shortlog(1) to produce correct and useful names and email addresses. An initial `.mailmap` has been added to correct some existing email addresses and duplications. `.mailmap` is documented in [Documentation/mailmap.txt][mailmap] for git. This adds a maintainer dependency on Ruby and the mustache gem. The autocontrib program is spiked out in Ruby due to my familarity with the language, but the choice of templating language (mustache) allows flexibility for switching languages later. This is a dependency requirement only for people who run `autogen.sh` -- maintainers. This adds a maintainer dependency on git. Again, this is only for maintainers, and many (all?) of them need git to get rcm's source anyway. Thanks to Patrick Brisbin and George Brocklehurst for the review. [mailmap]: https://github.com/git/git/blob/6a907786af835ac15962be53f1492f23e044f479/Documentation/mailmap.txt --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 62509ea..fcf9da1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Overview - We do not currently have a test suite. - Update `NEWS.md.in`. -- Update `rcm.7`. +- Update `.mailmap`. - Submit a pull request on GitHub. Explanation @@ -21,8 +21,11 @@ release. Bugfixes should be marked with `BUGFIX`. Small things (typos, code style) should be grouped but with multiple authors (`Documentation updates thanks to Dan Croak and Roberto Pedroso`). -Ensure your name is in the list of contributors in `man/rcm.7`. These -are alphabetical. +We use your name and email address as produced by `git-shortlog(1)`. You +can change how this is formatted by modifying `.mailmap`. More details +on that file can be found in the git [Documentation/mailmap.txt][mailmap]. Submit a pull request using GitHub. If there is a relevant bug, mention it in the commit message (`Fixes #42.`). + +[mailmap]: https://github.com/git/git/blob/6a907786af835ac15962be53f1492f2 -- cgit v1.2.3