README.md

rust-template

1. Checklist
2. Overview
3. Contributing

Checklist

Did you just clone this repository? Here is a checklist of things you should change before you start developing!

1. Determine whether to delete the Cargo.lock file and add an entry for it to the .gitignore. The decision to do this will depend on your project's dependency management needs. Refer to this section of the Rust FAQs for more information about the benefits and drawbacks of making this change.
2. Rename src/main.rs to src/lib.rs (and remove the main function) if your project will not be an executable binary. Likewise, be sure to remove all mentions of run command(s) from the CONTRIBUTING.md and Makefile.toml files.
3. Update other files according to your project's needs (e.g. Cargo.toml, README.md, CODEOWNERS, etc).

Overview

This is a template repository. It comes with support for the following:

• Support for all the items below on both Windows and Linux
• Linting via rust-clippy
• Formatting via rustfmt
• Unit testing
• Code coverage analysis and "pretty" coverage reporting via cargo-llvm-cov
• Orchestration of all of the above via cargo-make (see CONTRIBUTING.md for details)

This repository also includes other features which are not necessarily specific to Rust, but they have been added for demonstrative purposes:

• Sample Codecov configuration
• Execution of unit testing-, code coverage-, and Codecov-oriented tasks in an automated fashion via GitHub Actions workflows

Contributing

See CONTRIBUTING.md for developer-oriented information.