Thank you for considering contributing to m8s
! Here are some guidelines to help you get started.
- Install Rust: Follow the instructions on rust-lang.org.
- Clone the Repository:
git clone https://github.com/conradkleinespel/m8s.git cd m8s
- Set Up Git Hooks:
git config --local core.hooksPath githooks/
- Run the Project Locally:
cargo run
- Follow the Rust coding conventions.
- Ensure your code is formatted by running
cargo fmt
. - Run
cargo clippy
to catch common mistakes and improve your code.
- Fork the repository and create your branch from
main
. - If you've added code for new features or bug fixes, add corresponding tests.
- Ensure the test suite passes by running
cargo test
. - Submit a pull request with a clear description of your changes.
If you find a bug or have a feature request, please open an issue on GitHub.
Thank you for your contributions!