Issues
Report issues and suggest features and improvements on the GitHub issue tracker. Don't ask questions on the issue tracker - use the support channels instead.
If you want to file a bug, please provide all the necessary info listed in our issue reporting template (it's loaded automatically when you create a new GitHub issue).
It's usually a good idea to try to reproduce (obscure) bugs in isolation. You
can do this by cloning CIDER's GitHub repo and running make run-cider
inside
it. This will bring up Emacs with only the latest version of CIDER loaded. By
starting fresh, with the latest code, we can ensure that the problem at hand
isn't already fixed or caused by interactions with other packages.
Patches
Patches in any form are always welcome! GitHub pull requests are even better! :-)
Before submitting a patch or a pull request make sure all tests are passing and that your patch is in line with the contribution guidelines.
Documentation
Good documentation is just as important as good code.
Consider improving and extending the this manual and the community wiki.
Working on the Manual
The manual is generated from the markdown files in the doc folder of CIDER's GitHub repo and is published to Read the Docs. The MkDocs tool is used to convert the markdown sources to HTML.
To make changes to the manual you simply have to change the files under
doc
. The manual will be regenerated automatically when changes to those files
are merged in master
(or the latest stable branch).
You can install MkDocs
locally and use the command mkdocs serve
to see the
result of changes you make to the manual locally:
$ cd path/to/cider/repo
$ mkdocs serve
If you want to make changes to the manual's page structure you'll have to edit mkdocs.yml.
Donations
You can support the development of CIDER, clojure-mode and inf-clojure via Salt, Gratipay and PayPal.
Running the tests in batch mode
Install cask if you haven't already, then:
$ cd /path/to/cider
$ cask
Run all tests with:
$ make test
(Note: tests may not run correctly inside Emacs' shell-mode
buffers. Running
them in a terminal is recommended.)
You can also check for the presence of byte-compilation warnings in batch mode:
$ make test-bytecomp