From 95f3c06cf3cd3b56f813c3102d8073cf0d0d7535 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maxime=20=E2=80=9Cpep=E2=80=9D=20Buquet?= Date: Tue, 19 Dec 2023 12:17:48 +0100 Subject: [PATCH] README: Add note on contributing / cargo fmt MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Maxime “pep” Buquet --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9d51838e..c6316391 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,8 @@ Code changes should try to include documentation as possible. They should also include tests where appropriate, and pass the existing test suite. CI should pass to submit your changes. This is done by ensuring `cargo fmt` -and `cargo test` pass (in the workspace). +and `cargo test` pass (in the workspace). Please do not run `cargo fmt` as a +separate commit but do it as part of each of your commits. More thorough tests can be done locally with `act` or `forgejo-runner exec`, which is also what is run in the CI. We require docker to be setup for