Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create CONTRIBUTING.md #98

Merged
merged 1 commit into from
Oct 15, 2021
Merged

Create CONTRIBUTING.md #98

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.