Thank you for your interest in contributing!
This document describes the basic development workflow used by this repository.
RetroMount uses Rust stable.
The repository includes a rust-toolchain.toml, so Rustup will automatically install the required toolchain.
Clone the repository:
git clone https://github.com/lloydsmart/retromount
cd retromountBuild the project:
cargo buildcargo testAll code must pass rustfmt.
cargo fmtCI enforces this via:
cargo fmt --all -- --checkClippy warnings are treated as errors.
cargo clippy --all-targets --all-featuresPull requests must pass:
- formatting
- clippy
- build
- tests
across the supported CI platforms.
- Create a feature branch
- Ensure CI passes
- Open a pull request against
develop
Please include clear commit messages describing the purpose of the change.