1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
|
# Contributing Guidelines
**Do** follow [the seven rules of a great Git commit message][1].
**Do** follow [the Clojure Style Guide][2].
**Do** include tests for your change when appropriate.
**Do** ensure that the CI checks pass.
**Do** squash the commits in your PR to remove corrections
irrelevant to the code history, once the PR has been reviewed.
**Do** feel free to pester the project maintainers about the PR if it
hasn't been responded to. Sometimes notifications can be missed.
**Don't** overuse vertical whitespace; avoid multiple sequential blank
lines.
**Don't** include more than one feature or fix in a single PR.
**Don't** include changes unrelated to the purpose of the PR. This
includes changing the project version number, adding lines to the
`.gitignore` file, or changing the indentation or formatting.
**Don't** open a new PR if changes are requested. Just push to the
same branch and the PR will be updated.
[1]: https://chris.beams.io/posts/git-commit/#seven-rules
[2]: https://github.com/bbatsov/clojure-style-guide
|