Thank you for your interest in clj-headlights!
The GitHub issues section is the right place to do so. File an issue there an the team will review and discuss the report with you. Try to be as precise and detailed as possible. For both bug reports and suggestions, providing code snippets come a long way. Always include the version you are using. For bugs, reproduction steps are mandatory.
- Make sure you have a working Clojure development environment. This include a JDK, Clojure, and leiningen.
- Fork and clone the repository.
- Hack away.
- Make sure
lein testandlein eastwoodpass. - Submit a pull-request on GitHub.
When creating your pull-request, please include an explanation of why you would like the change to happen. For bugs it is usually trivial (nobody likes bugs in software), but for new features we need to understand why the addition would be helpful to you and everyone else.
Our objective is to avoid breaking changes as much as possible. We need a very good reason to do so. As a result, if you want to change the behavior or signature of a function, consider writing a new function with a different name.
As a general rule, abide by bbatsov's Clojure Style Guide.
In order to be merged, a pull-request requires two positive reviews from the team. Changes submitted by team members only require one approval.
Any new code change need to have associated tests. New functions need to have associated documentation.
This assumes you are a maintainer with push access to the com.logrhythm group on Clojars.
./scripts/release.sh X.Y.Z