From cf7b3c6e1f1d7324c8f4891d5d208ea66f35eaaa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Marcos=20Bezerra?= Date: Fri, 15 Oct 2021 10:47:37 -0300 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..67be18c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +Thanks for your interest in contributing to `ouch`! + +Feel free to open an issue anytime you wish to ask a question, suggest a feature, report a bug, etc. + +# Requirements + +1. Be kind, considerate and respectfull. +2. If editing .rs files, run `rustfmt` on them before commiting. + +Note that we are using `unstable` features of `rustfmt`, so you will need to change your toolchain to nightly. + +# Suggestions + +1. Ask for some guidance before solving an error if you feel like it. +2. If editing Rust code, run `clippy` before commiting.