First off, thank you for considering contributing to our project! It's people like you that make this community great.
To get you started quickly, here is everything you need to know to get your first Pull Request (PR) reviewed.
If you have questions, need help, or want to discuss a feature, please reach out via:
- GitHub Issues & Discussions: Please use this repository's official Issues and Discussions tabs to ask questions or report problems.
We keep our detailed technical documentation close to the code. Please refer to these guides:
-
First-time Setup: See Developer Onboarding to set up your toolchain.
-
Building & Running Tests: Check CLAUDE.md for quick commands on building and running the test suite.
-
Coding Style & Principles: Read our Coding Style Guide.
When creating a branch, use the following prefixes depending on your work:
-
feat/for new features (e.g.,feat/add-login-button) -
fix/for bug fixes (e.g.,fix/memory-leak) -
chore/for maintenance, CI/CD, or dependency updates (e.g.,chore/update-deps)
We use Commitizen conventions for clear history. Your commit messages should look like this:
type(scope): description (e.g., feat(auth): add OAuth2 support)
-
Fork the repository and create your branch from
main. -
Ensure your code passes all tests (e.g., cargo test --release).
-
Open a Pull Request against the
mainbranch. -
Fill out the PR template—our maintainers will review it shortly!