Contributing¶
Thank you for contributing to Auths.
| Guide | Description |
|---|---|
| Repo Layout | Crate structure and what goes where |
| Adding a Binding | How to add a new language binding |
| Release Process | Versioning and release steps |
| Security Notes | Security-sensitive areas and practices |
Quick start for contributors¶
Code quality¶
cargo fmt --all # Format
cargo fmt --check --all # Check formatting
cargo clippy --all-targets --all-features -- -D warnings # Lint
cargo audit # Security audit
Pull request process¶
- Fork the repository
- Create a feature branch (
git checkout -b feature/my-change) - Run
cargo fmt --allandcargo clippy --all -- -D warnings - Run
cargo test --all - Commit with a clear message (present tense: "Add support for..." not "Added support for...")
- Open a PR against
main
CI requirements¶
Tests require Git configuration:
CI runs on: Ubuntu (x86_64), macOS (aarch64), Windows (x86_64). Rust 1.93+.