README: Add note on contributing / cargo fmt

Signed-off-by: Maxime “pep” Buquet <pep@bouah.net>
This commit is contained in:
Maxime “pep” Buquet 2023-12-19 12:17:48 +01:00
parent ac4ffd2268
commit 95f3c06cf3

View file

@ -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