Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
17 lines (12 loc) · 924 Bytes

CONTRIBUTING.md

File metadata and controls

17 lines (12 loc) · 924 Bytes

Contributing to cargo-rdme

Thank you for your interest in contributing to cargo-rdme. We appreciate it!

It is a good idea for you to open an issue before you start working on non-trivial features. This way we can discuss if the feature is desirable and how to best design and implement it.

Useful tools

If you are contributing with a pull request you probably want to know about these scripts:

  • ./tools/check.sh — Checks that everything is fine. This includes checking that everything builds, the unit tests pass, and the code is correctly formatted. If you need to format the code run cargo fmt.
  • ./tools/codecov.sh — Creates a code coverage report. There is not a strict code coverage threshold, but we do want pretty much everything tested.
  • cargo rdme — Of course we use cargo-rdme to update our README.