# Contributing to shipflow
Thanks for your interest in contributing!
## Getting started
1. Fork and clone the repository
2. Install Rust 1.88+ (see `rust-toolchain.toml`)
3. Run the test suite:
```bash
cargo test
cargo clippy -- -D warnings
cargo fmt --check
```
## Pull requests
- Use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages (`feat:`, `fix:`, `docs:`, `chore:`, etc.)
- Keep PRs focused — one logical change per PR
- Add or update tests for behavior changes
- Update README/docs when user-facing behavior changes
## Architecture changes
Non-trivial design decisions should be documented as ADRs in `docs/adr/`.
## Release CI (cargo-dist)
`.github/workflows/release.yml` is **autogenerated**. Do not edit it by hand or merge Dependabot PRs that bump its action versions.
To refresh after a `cargo-dist` upgrade:
```bash
dist generate
git add .github/workflows/release.yml dist-workspace.toml
git commit -m "chore: regenerate cargo-dist CI"
```
## Code style
- `cargo fmt` before committing
- No `unwrap()` / `expect()` in production code (enforced by clippy)
- Respect terminal conventions (`NO_COLOR`, pipe detection)
## Reporting issues
Include your OS, `shipflow --version`, and steps to reproduce. Redact any private task titles if needed.