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 runcargo 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
— TheREADME.md
is auto-generated based on the crate’s documentation insrc/lib.rs
. To update it run this script.