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 Projectile's GitHub repo and running
make run-projectile inside
it. This will bring up Emacs with only the latest version of Projectile 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 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.
Good documentation is just as important as good code.
Consider improving and extending this manual and the community wiki.
Working on the Manual
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/projectile/repo $ mkdocs serve
If you want to make changes to the manual's page structure you'll have to edit mkdocs.yml.
Running the tests in batch mode
$ cd /path/to/projectile $ make update $ make compile $ make test
Run all tests with:
$ make test
Tests should run fine in
term-mode. It's also possible to use M-x