From fcd3f2d3a793895e2695ad6bf52fde9578f6b148 Mon Sep 17 00:00:00 2001 From: Mike Burns Date: Thu, 27 Feb 2014 18:35:41 +0100 Subject: Add a list of contributors to rcm(7) This list is an alphabetical listing of everyone who has authored at least one commit, plus their email address. When the author is a coworker I have changed this to use their thoughtbot email address. This also updates the `AUTHORS` section to mention thoughtbot. The `NEWS.md.in` file has been changed to reflect that 1.2.0 is released. A `CONTRIBUTING.md` file has been added to explain what is required to send a good contribution. --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..62509ea --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +Contributing +============ + +Overview +-------- + +- We do not currently have a test suite. +- Update `NEWS.md.in`. +- Update `rcm.7`. +- Submit a pull request on GitHub. + +Explanation +----------- + +Since we do not yet have a test suite, you should make sure to install +and try your patch in a various scenarios. We will also entertain a +contribution with a test case. + +Consider updating `NEWS.md.in`. The topmost section is for the upcoming +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. + +Submit a pull request using GitHub. If there is a relevant bug, mention +it in the commit message (`Fixes #42.`). -- cgit v1.2.3