First off, thank you for considering contributing to cloudmqtt.
If your contribution is not straightforward, please first discuss the change you wish to make by creating a new issue before making the change.
Before reporting an issue on the issue tracker, please check that it has not already been reported by searching for some related keywords.
Try to do one pull request per change.
This is no different than other Rust projects.
git clone https://github.com/TheNeikos/cloudmqtt
cd cloudmqtt
cargo test
Make sure that you have at least the version as specified in the rust-toolchain
file.
The repository is a nix flake. Be sure to have flake support enabled to check out this repository.
nix shell
cargo test
-
Build and run the binary:
cargo run --release -F bin
-
Run Clippy:
cargo clippy --all-targets --all-features --workspace
-
Run all tests:
cargo test --all-features --workspace
-
Check to see if there are code formatting issues
cargo fmt --all -- --check
-
Format the code in the project
cargo fmt --all