Contributing

Thanks for contributing! To keep the repository consistent and avoid regressions we provide a Git pre-commit hook that runs:

How to enable the hook (recommended):

Run the install script from the repository root:
```
./scripts/install-hooks.sh
```
This sets git config core.hooksPath .githooks and makes the pre-commit hook executable.

Verify with a test commit or run the checks manually:

cargo fmt --all -- --check && cargo clippy --all-targets -- -D warnings && cargo test --workspace

If you prefer not to enable the hook globally for the repository, you can still run the checks locally before committing.

Thanks for keeping the codebase healthy!

Releasing to crates.io

Releases are automated via GitHub Actions. To publish a new version:

Commit and push the version bump:

git add Cargo.toml
git commit -m "Bump version to 0.2.0"
git push origin main

Create and push a tag matching the version:
```
git tag v0.2.0
git push origin v0.2.0
```

The publish.yml workflow will:

A CRATES_TOKEN secret must be configured in the repository settings:

Generate a token at https://crates.io/settings/tokens
Add it as a repository secret: Settings → Secrets → Actions → New repository secret

You can trigger a dry-run publish manually via the Actions tab: