Development Instructions

Building

./scripts/lein-modules do clean, install

Running tests

./scripts/test.sh clj
./scripts/test.sh cljs

Formatting

clojure-lsp format
clojure-lsp clean-ns

Documentation

The documentation lives under doc and it is hosted on cljdoc. See their documentation for library authors

Updating deps

• lein ancient upgrade
• Mention non-dev non-test dep upgrades in CHANGELOG.md
• npm update --save
• Make a PR, run CI

Making a release

We use Break Versioning. Remember our promise: patch-level bumps never include breaking changes!

# create a release commit
./scripts/set-version "1.0.0"

# !!! update the changelog

git add -u
git commit -m "Release 1.0.0"

# push the commit
git push

# !!! check that tests pass on CI

• Create a new release on github at https://github.com/metosin/reitit/releases
  • This will trigger the automated release workflow https://github.com/metosin/reitit/actions/workflows/release.yml
• Announce the release at least on #reitit in Clojurians.