Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (23 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.04 KB
Raw

contributing to hop

contributions are welcome. please review these principles before submitting a pull request.

design principles

  • deterministic only: no frecency, no fuzzy guessing, no background indexing. 1:1 key-to-target mapping always.
  • sub-millisecond execution: no network calls, no daemons, minimal startup overhead.
  • restraint: zero decorative features or abstractions for single use-cases. keep the binary under 2mb.
  • tokyo night truecolor: all ui colors must strictly adhere to the palette defined in src/theme.rs.
  • lowercase aesthetic: all user-facing strings, cli help, and error messages remain lowercase. no emoji.

local development

# run test suite
cargo test

# format check
cargo fmt --check

# lint check (zero warnings permitted)
cargo clippy --all-targets -- -D warnings

# build optimized release binary
cargo build --release

pull request checklist

  1. all unit tests pass.
  2. cargo clippy --all-targets -- -D warnings succeeds with zero warnings.
  3. cargo fmt --check produces no diff.