Do you have an issue to report or an idea to submit? That's great! We're eager to make clj-refactor better. Please report issues to the issue tracker of the repository or submit a pull request.
To help us, please, follow these guidelines:
- 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.
- Mention the version you're running. You can call
cljr-version
to obtain this information. - Mention the CIDER version you're running.
- Mention the leiningen or boot version you're using.
- Mention your Emacs version and operating system.
- Include any relevant code to the issue summary.
- Read how to properly contribute to open source projects on Github.
- Use a topic branch to easily amend a pull request later, if necessary.
- Write good commit messages.
- Mention related tickets in the commit messages (e.g.
[Fix #N] Add command ...
) - Update the changelog.
- Use the same coding conventions as the rest of the project.
- 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.
- Fork and clone the repository.
- Install [Cask][7].
- Run
cask install
in the repository folder. - Run tests with
make test
.