Template for Rust projects @okp4.

version build lint test codecov conventional commits semantic-release contributor covenant License

This repository holds the template for building Rust projects with a consistent set of standards across all OKP4 projects. We are convinced that the quality of the code depends on clear and consistent coding conventions, with an automated enforcement (CI).

This way, the template promotes:

• the use of conventional commits, semantic versioning and semantic releasing which automates the whole package release workflow including: determining the next version number, generating the release notes, and publishing the artifacts (project tarball, docker images, etc.)
• unit testing
• linting via rust-clippy
• formatting via rustfmt
• a uniform way of building via cargo-make

🚨 do not fork this repository as it is a template repository

1. Click on Use this template
2. Give a name to your project
3. Wait until the first run of CI finishes
4. Clone your new project and happy coding!

⚠ Do not forget to adapt your project to your needs by editing the Cargo.toml file.

Be sure you have Rust properly installed with cargo-make.

cargo make