Contributing
aztec-rs is an open-source Rust workspace.
Contributions are welcome via pull requests on GitHub.
Before You Start
- Discuss non-trivial changes in a GitHub issue first.
- Read the Architecture overview to locate the right crate.
- Skim recent entries in the
CHANGELOG.md.
Workflow
- Fork + branch.
- Build locally (
cargo build). - Run tests (
cargo test), including any new ones. - Run
cargo lint(the strict Clippy alias) andcargo fmt. - Update documentation — see Writing Documentation.
- Open a PR with a clear description and changelog entry when appropriate.
Commit Style
- One logical change per commit.
- Use the imperative mood (“add x”, “fix y”).
Code of Conduct
Be respectful and constructive.