Skip to content
Browse files

added contribution guidelines

  • Loading branch information...
1 parent f242489 commit 02ef7394e03937af1bc2122e28fd6dba15db249f @bbatsov committed Jan 5, 2013
Showing with 31 additions and 0 deletions.
  1. +31 −0 CONTRIBUTING.md
View
31 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` (<kbd>C-c ? d</kbd>).
+* 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

0 comments on commit 02ef739

Please sign in to comment.
Something went wrong with that request. Please try again.