Merge pull request #98 from ouch-org/create-contributing-md

Create CONTRIBUTING.md
ouch-org · Oct 15, 2021 · 1bcdfeb · 1bcdfeb
2 parents 8224aab + cf7b3c6
commit 1bcdfeb
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/CONTRIBUTING.md 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.