Contributing

Code Quality

All code must pass the following checks without warnings:

These checks are enforced in CI.

All files must include SPDX license headers. See the SPDX specification for details. Compliance is checked with reuse lint in CI.

This project follows the Conventional Commits specification.

Releases are managed with cargo-release. Install it with:

cargo install cargo-release

cargo-release is configured to push to a git remote named upstream. Before releasing, add it:

git remote add upstream git@github.com:GSI-HPC/unjam.git

cargo release patch  # 0.1.0 → 0.1.1
cargo release minor  # 0.1.0 → 0.2.0
cargo release major  # 0.1.0 → 1.0.0

This bumps the version in Cargo.toml, commits, tags, and pushes to upstream. CI then runs checks and publishes to crates.io automatically.