Skip to content

Commit

Permalink
Improved contributing guidelines.
Browse files Browse the repository at this point in the history
  • Loading branch information
orium committed Nov 28, 2023
1 parent 338754d commit a5c55a4
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions CONTRIBUTING.md
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.

0 comments on commit a5c55a4

Please sign in to comment.