Skip to content

Latest commit

 

History

History
13 lines (10 loc) · 802 Bytes

CONTRIBUTING.md

File metadata and controls

13 lines (10 loc) · 802 Bytes

Contributing to rpds

Thank you for your interest in contributing to rpds. We appreciate it!

If you are contributing with a pull request you might want to know about a few 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.
  • ./tools/update-readme.sh — The README.md is auto-generated based on the crate’s documentation in src/lib.rs. To update it run this script.