|
| 1 | +# Contributing |
| 2 | + |
| 3 | +If you discover issues, have ideas for improvements or new features, |
| 4 | +please report them to the [issue tracker][1] of the repository or |
| 5 | +submit a pull request. Please, try to follow these guidelines when you |
| 6 | +do so. |
| 7 | + |
| 8 | +## Issue reporting |
| 9 | + |
| 10 | +* Check that the issue has not already been reported. |
| 11 | +* Check that the issue has not already been fixed in the latest code |
| 12 | + (a.k.a. `master`). |
| 13 | +* Be clear, concise and precise in your description of the problem. |
| 14 | +* Open an issue with a descriptive title and a summary in grammatically correct, |
| 15 | + complete sentences. |
| 16 | +* Mention your Emacs version and operating system. |
| 17 | +* Mention the `inf-clojure` version. |
| 18 | +* Include any relevant code to the issue summary. |
| 19 | + |
| 20 | +## Pull requests |
| 21 | + |
| 22 | +* Read [how to properly contribute to open source projects on Github][2]. |
| 23 | +* Use a topic branch to easily amend a pull request later, if necessary. |
| 24 | +* Write [good commit messages][3]. |
| 25 | +* Mention related tickets in the commit messages (e.g. `[Fix #N] Add command ...`) |
| 26 | +* Use the same coding conventions as the rest of the project. |
| 27 | +* Verify your Emacs Lisp code with `checkdoc` (<kbd>C-c ? d</kbd>). |
| 28 | +* [Squash related commits together][5]. |
| 29 | +* Open a [pull request][4] that relates to *only* one subject with a clear title |
| 30 | + and description in grammatically correct, complete sentences. |
| 31 | + |
| 32 | +[1]: https://github.com/clojure-emacs/inf-clojure/issues |
| 33 | +[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request |
| 34 | +[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html |
| 35 | +[4]: https://help.github.com/articles/using-pull-requests |
| 36 | +[5]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html |
0 commit comments