From 02ef7394e03937af1bc2122e28fd6dba15db249f Mon Sep 17 00:00:00 2001 From: Bozhidar Batsov Date: Sat, 5 Jan 2013 14:38:32 +0200 Subject: [PATCH] added contribution guidelines --- CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..695df55 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,31 @@ +# Contributing + +If you discover issues, have ideas for improvements or new features, or +want to contribute a new module, please report them to the +[issue tracker][1] of the repository or submit a pull request. Please, +try to follow these guidelines when you do so. + +## Issue reporting + +* Check that the issue has not already been reported. +* Check that the issue has not already been fixed in the latest code + (a.k.a. `master`). +* Be clear, concise and precise in your description of the problem. +* Open an issue with a descriptive title and a summary in grammatically correct, + complete sentences. +* Include any relevant code to the issue summary. + +## Pull requests + +* Read [how to properly contribute to open source projects on Github][2]. +* Use a topic branch to easily amend a pull request later, if necessary. +* Write [good commit messages][3]. +* Use the same coding conventions as the rest of the project. +* Verify your Emacs Lisp code with `checkdoc` (C-c ? d). +* Open a [pull request][4] that relates to *only* one subject with a clear title + and description in grammatically correct, complete sentences. + +[1]: https://github.com/bbatsov/prelude/issues +[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request +[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html +[4]: https://help.github.com/articles/using-pull-requests