Update CONTRIBUTING.md (#132)

This commit is contained in:
João Marcos Bezerra 2021-10-31 02:15:40 -03:00 committed by GitHub
parent 77873cde15
commit 038da118ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -4,12 +4,12 @@ Feel free to open an issue anytime you wish to ask a question, suggest a feature
# Requirements # Requirements
1. Be kind, considerate and respectfull. 1. Be nice to other people.
2. If editing .rs files, run `rustfmt` on them before commiting. 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 # Suggestions
1. Ask for some guidance before solving an error if you feel like it. 1. If you wish to, you can ask for some guidance before solving an issue.
2. If editing Rust code, run `clippy` before commiting. 2. Run `cargo clippy` too.