CONTRIBUTING.md (2495B)
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 CIDER version info. You can use the REPL version info, which looks like that: 18 19 ```el 20 ;; CIDER 0.12.0snapshot (package: 20160331.421), nREPL 0.2.12 21 ;; Clojure 1.8.0, Java 1.8.0_31 22 ``` 23 24 * Include any relevant code to the issue summary. 25 26 ### Reporting bugs 27 28 When reporting bugs it's a good idea to go through the [Troubleshooting section 29 of the manual][7]. Adding information like the backtrace and the nREPL messages to 30 the bug report makes it easier to track down bugs. Some steps to reproduce a bug 31 reliably would also make a huge difference. 32 33 ## Pull requests 34 35 * Read the [Hacking on CIDER][8] manual section. 36 * Read [how to properly contribute to open source projects on Github][2]. 37 * Use a topic branch to easily amend a pull request later, if necessary. 38 * Use the same coding conventions as the rest of the project. 39 * Verify your Emacs Lisp code with `checkdoc` (<kbd>C-c ? d</kbd>). 40 * Make sure that the unit tests are passing (`eldev test`). 41 * Make sure that there are no lint warnings (`eldev lint`). 42 * Write [good commit messages][3]. 43 * Mention related tickets in the commit messages (e.g. `[Fix #N] Add command ...`). 44 * Update the [changelog][6]. 45 * [Squash related commits together][5]. 46 * Open a [pull request][4] that relates to *only* one subject with a clear title 47 and description in grammatically correct, complete sentences. 48 49 [1]: https://github.com/clojure-emacs/cider/issues 50 [2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request 51 [3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html 52 [4]: https://help.github.com/articles/using-pull-requests 53 [5]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html 54 [6]: https://github.com/clojure-emacs/cider/blob/master/CHANGELOG.md 55 [7]: http://cider.readthedocs.org/en/latest/troubleshooting/ 56 [8]: https://cider.readthedocs.io/en/latest/hacking_on_cider/