Contributing¶

Quick start¶

# Install dev dependencies + editable extension
just install

# Run linters (prek, ruff)
just lint

# Run tests (Rust + Python + TypeScript)
just test

# Run type checkers (Pyrefly + TypeScript)
just typecheck

Documentation¶

just docs-serve    # Preview site at http://localhost:8000
just docs-build    # Strict production build

The documentation site is built with Zensical from Markdown files in docs/.

Quality gates¶

Before opening a pull request, ensure all gates pass:

just lint
just test
just typecheck

Pull requests also run the Zensical documentation build to catch broken links and validation errors.

License¶

This project is licensed under the MIT License. See LICENSE for details.