Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (38 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 1.29 KB
Raw

Contributing

Thanks for contributing to blippy.

Local Setup

  • Rust 1.93+ recommended
  • GitHub CLI (gh) strongly recommended
  • Clone and run:
cargo run --release

Build, Test, Lint

cargo build --release
cargo test
cargo clippy --all-targets --all-features

Format before opening a PR:

cargo fmt

Project Conventions

  • Use conventional commits (feat, fix, docs, style, refactor, test, chore, perf)
  • Keep changes scoped and focused
  • Avoid unnecessary comments when code can be made self-explanatory

Pull Requests

  • Keep PRs small and focused
  • Explain what problem is being solved and why the change fixes it
  • Link related issues in the PR description
  • Add or update tests for behavior changes

Releases and Changelog

  • Releases are automated via GitHub Actions (release-plz + cargo-dist)
  • CHANGELOG.md is maintained by the release workflow
  • Do not manually hand-edit changelog entries for normal feature work

Docs to Update with Feature Changes

When behavior changes, update: