Documentation
Contributing
How to prepare changes, run checks, and keep docs and tests aligned.
Expectations
- use Rust
1.90or newer - keep code and user-facing messages in English
- keep changes focused
- update tests and docs with behavior changes
Standard checks
cargo fmt --all --check
cargo clippy --workspace --all-targets --all-features -- -D warnings
cargo test --workspaceDocumentation expectations
When behavior changes:
- update
README.mdif onboarding or positioning changed - update
website/if public docs changed - update example TOML files if the configuration model changed
- update rustdoc when public Rust APIs change
Pull requests
Include:
- a short summary
- validation steps
- relevant test updates
- relevant docs updates