From a5c55a4cf48830d90208235f5f2d26798e124523 Mon Sep 17 00:00:00 2001 From: Diogo Sousa Date: Tue, 28 Nov 2023 21:17:07 +0000 Subject: [PATCH] Improved contributing guidelines. --- CONTRIBUTING.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aa0fbf0..0034398 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.