Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (24 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

32 lines (24 loc) · 1.11 KB
Raw

Contributing to headroom-hook

Thanks for your interest. This is a small, standalone Rust binary — a Busbar hook that compresses chat history with headroom-core.

Ground rules

  • Be respectful and constructive (see CODE_OF_CONDUCT.md).
  • By contributing, you agree your contributions are licensed under the project's Apache-2.0 license.

Build and test

cargo build --release      # the shipped binary
cargo test                 # unit + wire tests
cargo clippy --all-targets -- -D warnings   # lints must be clean
cargo fmt --all            # format before committing

The core (src/compress.rs, src/main.rs) stays lean; tests live in src/tests/. Keep it that way — a hook is read by the people deciding whether to trust it on their request path.

Before a PR

  1. cargo fmt --all — rustfmt-clean.
  2. cargo clippy --all-targets -- -D warnings — no warnings.
  3. cargo test — green.
  4. If you touch the wire behavior, add or update a test in src/tests/ that pins it.