Thank you for your interest in contributing! This document outlines the process for making contributions.
- Fork the repository on GitHub
- Clone your forked repo locally
- Install dependencies:
cargo build - Run tests to verify your setup:
cargo test
- Create a new branch for your feature/fix:
git checkout -b my-feature - Make your changes to the codebase
- Write tests for new functionality (if applicable)
- Verify all tests pass:
cargo test --all-targets - Ensure the code builds:
cargo build --release
Follow Rust's standard code style and use cargo fmt before committing:
cargo fmt- Commit your changes with a clear, descriptive message:
git commit -m "feat: add XYZ functionality" - Push your branch to your fork:
git push origin my-feature - Open a pull request (PR) on the main repository
- Your PR will be reviewed and merged after approval
If you find a bug or have a feature request, please open an issue on GitHub with clear details:
- Steps to reproduce the problem (if bug)
- Expected behavior
- Actual behavior
- System information (Rust version, OS, etc.)
We expect all contributors to be respectful and inclusive in their interactions.