Contributing¶

How to contribute to HyperbyteDB.

Before you open a PR¶

1. Branch from main.
2. Follow Coding standards.
3. Run the same checks as CI:

cargo fmt --all --check
cargo clippy --all-targets -- -D warnings
cargo test --lib
cargo test --test '*'

1. Document new config keys in Configuration and config.toml.example.
2. Open a PR against main. CI must pass.

Code review¶

PRs are reviewed against the code review rubric. Highlights:

• Correctness — data path integrity, cluster safety, InfluxDB v1 compatibility, query translation.
• Tests — each suite has a defined scope; do not duplicate coverage without reason.
• Docs — config and operator changes need matching documentation updates.

Commit conventions¶

• Use clear, descriptive commit messages.
• Reference issues when applicable.
• Keep commits focused on one logical change.

Dependencies¶

• Use Arc<dyn Trait> for dependency injection at service boundaries.
• Keep domain types free of I/O dependencies.
• Pin major versions of GitHub Actions.
• Commit Cargo.lock.

Getting help¶

Further reading¶