Contributions are welcome!
- Please file bug reports and feature requests to https://github.com/metosin/reitit/issues
- For small changes, such as bug fixes or documentation changes, feel free to send a pull request.
- If you want to make a big change or implement a big new feature, please open an issue to discuss it first.
If you have questions about contributing or about reitit in general, join the #reitit channel in Clojurians Slack.
- Clone this git repository
- For CLJS support, install NPM dependencies:
npm install
.
- Fork the repository on Github
- Create a topic branch from where you want to base your work (usually the master branch)
- Check the formatting rules from existing code (no trailing whitespace, mostly default indentation)
- Ensure any new code is well-tested, and if possible, any issue fixed is covered by one or more new tests
- Verify that all tests pass using
./scripts/test.sh clj
and./scripts/test.sh cljs
. - Push your code to your fork of the repository
- Make a Pull Request
For more development instructions, see the manual.
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- "Add x", "Fix y", "Support z", "Remove x"
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how