From 038da118ecc0d9fc844bac5d1921528035e2b862 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Marcos=20Bezerra?= Date: Sun, 31 Oct 2021 02:15:40 -0300 Subject: [PATCH] Update CONTRIBUTING.md (#132) --- CONTRIBUTING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 67be18c..1bf3f44 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,12 +4,12 @@ Feel free to open an issue anytime you wish to ask a question, suggest a feature # Requirements -1. Be kind, considerate and respectfull. -2. If editing .rs files, run `rustfmt` on them before commiting. +1. Be nice to other people. +2. If editing the Rust source code, remember to run `rustfmt` (otherwise, CI will warn you the code was not properly formatted). -Note that we are using `unstable` features of `rustfmt`, so you will need to change your toolchain to nightly. +Note: we are using `unstable` features of `rustfmt`! Nightly toolchain is required (will likely be installed automatically, cause the toolchain was specified in the project root). # Suggestions -1. Ask for some guidance before solving an error if you feel like it. -2. If editing Rust code, run `clippy` before commiting. +1. If you wish to, you can ask for some guidance before solving an issue. +2. Run `cargo clippy` too.