If you discover issues, have ideas for improvements or new features, please report them to the issue tracker of the repository or submit a pull request. Please, try to follow these guidelines when you do so.
- 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.
- Mention your Emacs version and operating system.
- Mention the CIDER version info. You can use the REPL version info, which looks like that:
;; CIDER 0.12.0snapshot (package: 20160331.421), nREPL 0.2.12
;; Clojure 1.8.0, Java 1.8.0_31- Include any relevant code to the issue summary.
When reporting bugs it's a good idea to go through the Troubleshooting section of the manual. Adding information like the backtrace and the nREPL messages to the bug report makes it easier to track down bugs. Some steps to reproduce a bug reliably would also make a huge difference.
- Read the Hacking on CIDER manual section.
- Read how to properly contribute to open source projects on Github.
- Use a topic branch to easily amend a pull request later, if necessary.
- Use the same coding conventions as the rest of the project.
- Verify your Emacs Lisp code with
checkdoc(C-c ? d). - Make sure that the unit tests are passing (
eldev test). - Make sure that there are no lint warnings (
eldev lint). - Write good commit messages.
- Mention related tickets in the commit messages (e.g.
[Fix #N] Add command ...). - Update the changelog.
- Squash related commits together.
- Open a pull request that relates to only one subject with a clear title and description in grammatically correct, complete sentences.