-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
11 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,17 @@ | ||
# Contributing to dirty-debug | ||
|
||
Thank you for your interest in contributing to dirty-debug. We appreciate it! | ||
Thank you for your interest in contributing to dirty-debug. We appreciate it! | ||
|
||
If you are contributing with a pull request you might want to know about a few scripts: | ||
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. | ||
|
||
* [`./tools/check.sh`](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 | ||
## Useful tools | ||
|
||
If you are contributing with a pull request you probably want to know about these scripts: | ||
|
||
* [`./tools/check.sh`](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`](tools/codecov.sh) — Creates a code coverage report. There is not a strict code coverage | ||
* [`./tools/codecov.sh`](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`](https://crates.io/crates/cargo-rdme) — Updates the README with the crate’s rustdoc. |