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

Create CONTRIBUTING.md
This commit is contained in:
João Marcos Bezerra 2021-10-15 11:18:34 -03:00 committed by GitHub
commit 1bcdfeb41c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

15
CONTRIBUTING.md Normal file
View File

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