Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

74 lines (48 loc) · 1.33 KB

Contribution guidelines

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.

Reporting issues

Before reporting an issue on the issue tracker, please check that it has not already been reported by searching for some related keywords.

Pull requests

Try to do one pull request per change.

Developing

Set up

Non-Nix setups

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.

Nix setups

The repository is a nix flake. Be sure to have flake support enabled to check out this repository.

nix shell
cargo test

Useful Commands

  • 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