CONTRIBUTING.md

   1 Thanks for your interest in contributing to `ouch`!
   2
   3 Feel free to open an issue anytime you wish to ask a question, suggest a feature, report a bug, etc.
   4
   5 # Requirements
   6
   7 1. Be nice to other people.
   8 2. If editing the Rust source code, remember to run `rustfmt` (otherwise, CI will warn you the code was not properly formatted).
   9 3. If new formats are added, please add the format to `tests/integration.rs`.
  10 If it is an archive format that handles directories, it should be added to `DirectoryExtension`, otherwise it should be added to `FileExtension`.
  11 It should be added to `mime.rs` as well if the [`infer`](https://docs.rs/infer) crate supports it.
  12 Most tests are written with `proptest` ([book](https://altsysrq.github.io/proptest-book/), [docs](https://docs.rs/proptest)).
  13 If you wish to improve these tests, the proptest book might help you.
  14
  15 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).
  16
  17 # Suggestions
  18
  19 1. If you wish to, you can ask for some guidance before solving an issue.
  20 2. Run `cargo clippy` too.