First off, thank you for considering contributing to molio.
If your contribution is not straightforward, please first discuss the change you wish to make by creating a new issue before making the change.
One of the project goals is to be easy to understand so, especially for github actions, try to keep things simple and to add comments whenever this is not possible.
Issues have to be reported on our issues tracker. Please:
- Check that the issue has not already been reported.
- This can be achieved by searching keywords on the issues tracker.
- Try to use a clear title, and describe your problem with complete sentences.
Try to do one pull request per change.
This is no different than other Rust projects.
git clone https://github.com/chem-william/molio
cd molio
cargo build-
Build and run release version:
cargo build --release && cargo run --release -
Run Clippy:
cargo clippy
-
Run all tests:
cargo test --all -
Check to see if there are code formatting issues
cargo fmt --all -- --check
-
Format the code in the project
cargo fmt --all