52 lines (39 loc) · 1.32 KB

Contributing to OMNI

Prerequisites

Rust (stable, 2024 edition)

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

cargo-insta (for snapshot tests)
```
cargo install cargo-insta
```

Getting Started

git clone https://github.com/fajarhide/omni.git
cd omni
cargo build
cargo test    # All 147 tests should pass

Development Workflow

Create a feature branch: git checkout -b feature/my-feature
Make changes
Run: cargo fmt && cargo clippy && cargo test
Review snapshots if changed: cargo insta review
Submit a PR

What We Welcome

New distillers for uncommon tools
TOML filters for popular tools
Performance optimizations
Documentation improvements
Bug fixes

Code Style

Run cargo fmt before committing
cargo clippy -- -D warnings must pass (enforced in CI)
All hooks must handle errors gracefully (no panics in production paths)
Add tests for new functionality

See Also

CLAUDE.md — Full developer guide (project structure, architecture)
tests/README.md — Critical Guardrails (Avoid deadlocks & hangs)
docs/DEVELOPMENT.md — Detailed development setup
docs/FILTERS.md — How to write TOML filters