From 05ebfed25f1bbc5de450c09131e35c46f33e0def Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Marcos=20Bezerra?= Date: Sun, 16 Oct 2022 15:31:13 -0300 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2a89115..6c5394d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,20 +1,19 @@ 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. +# Code of Conduct -# Requirements +We follow the [Rust Official Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct). -1. Be nice to other people. -2. If editing the Rust source code, remember to run `rustfmt` (otherwise, CI will warn you the code was not properly formatted). -3. If new formats are added, please add the format to `tests/integration.rs`. -If it is an archive format that handles directories, it should be added to `DirectoryExtension`, otherwise it should be added to `FileExtension`. -It should be added to `mime.rs` as well if the [`infer`](https://docs.rs/infer) crate supports it. -Most tests are written with `proptest` ([book](https://altsysrq.github.io/proptest-book/), [docs](https://docs.rs/proptest)). -If you wish to improve these tests, the proptest book might help you. +# I want to ask a question or provide feedback -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). +Create [an issue](https://github.com/ouch-org/ouch/issues) or go to [Ouch Discussions](https://github.com/ouch-org/ouch/discussions). -# Suggestions +# Adding a new feature -1. If you wish to, you can ask for some guidance before solving an issue. -2. Run `cargo clippy` too. +Before creating a PR with a new feature, please, open an issue to suggest your addition. + +This allows us to discuss the problem and solution, increasing the chance of your PR to be accepted. + +# Don't forget to + +- In your PR, add a CHANGELOG.md entry.