github/ouch
1
1
Fork 0
mirror of https://github.com/ouch-org/ouch.git synced 2025-06-06 11:35:45 +00:00
Code Issues 15 Packages Projects Releases Wiki Activity

Merge pull request #301 from ouch-org/update-contributing-dot-md

Browse Source 
Update `CONTRIBUTING.md`
This commit is contained in:
João Marcos Bezerra 2022-10-16 19:54:02 -03:00 committed by GitHub
commit 645ad65c72
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
CONTRIBUTING.md
View File

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