diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e50cc51 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,12 @@ +## Pre-requisites + +The project uses [Leiningen 2](https://leiningen.org) and requires MongoDB `2.4+` to be running +locally. Make +sure you have those two installed and then run tests against all supported Clojure versions using + + lein2 all test + +## Pull Requests + +Then create a branch and make your changes on it. Once you are done with your changes and all +tests pass, write a [good, detailed commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) submit a pull request on GitHub.