CONTRIBUTING.md

Contributing

Setup

Rust is required to build and work on the project.

Development

# Build
cargo build

# Test
cargo test

# Format
cargo fmt

# Run (from a repo with .github/workflows)
cargo run -p action-format

Testing

For running tests, we recommend nextest.

cargo nextest run

Snapshot testing

We use insta for snapshot testing. Install cargo-insta for a better review experience.

cargo test
cargo insta review

Documentation

To build the documentation locally:

uv run --isolated --with-requirements docs/requirements.txt zensical serve