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

add information about tests to CONTRIBUTING.md

Browse Source
This commit is contained in:
figsoda 2021-11-07 12:18:56 -05:00
parent 2b9023e180
commit c4a71d85ed
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CONTRIBUTING.md
View File

@ -6,6 +6,11 @@ Feel free to open an issue anytime you wish to ask a question, suggest a feature
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.
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).