Contributing

Clone the repo and sync the environment with uv:

git clone https://github.com/norlandrhagen/corduroy
cd corduroy
uv sync --all-groups

Run tests:

uv run pytest tests -n auto

Lint and format:

uv run prek run --all-files

Type check:

uv run ty check src/

Build and preview the docs:

uv sync --group docs
uv run mkdocs serve

CI runs the test suite on Python 3.12, 3.13 and 3.14; the lint job runs prek and ty. Docs deploy to GitHub Pages from main.

License

This code is licensed under the MIT License — see the LICENSE file for details.