Contributions are welcome — bug reports, feature ideas, documentation improvements, or code. This guide covers a few things that will help your contribution land smoothly.
just check # Format check + clippy
just test # All tests including doctestsOr directly with cargo:
cargo test --workspace --all-features
cargo clippy --workspace --all-targets --all-features -- -D warningsmain always tracks the current release series. All PRs target main unless backporting a fix to an older series.
Maintenance branches (e.g., 0.2.x) exist for critical bugfixes to previous versions. These branches receive only bugfixes — no new features or API changes.
| What you're contributing | Target branch |
|---|---|
| Bugfix, feature, or docs for current release | main |
| Critical bugfix for a previous version | maintenance branch (e.g., 0.2.x) |
If you're unsure which branch to target, just ask in the issue or PR — happy to help.
Not all open issues are ready for implementation. Some are rough ideas or proposals still being discussed.
ready— problem is understood, scope is clear, ready to be picked upgood first issue— a good starting point for new contributorsfeature proposal— an idea open for discussion. Feedback and opinions are welcome, but please don't start implementing until the approach is agreed on
When in doubt, leave a comment on the issue before writing code. A quick conversation upfront prevents wasted effort.
- Keep PRs focused — one concern per PR
- Include tests for new functionality
- Run
just checkbefore submitting - Describe what the PR does and why, not just how
Open an issue or start a discussion. If something is unclear, that's worth fixing.