CONTRIBUTING.md

   1 Thanks for your interest in contributing to `ouch`!
   2
   3 # Table of contents:
   4
   5 - [Code of Conduct](#code-of-conduct)
   6 - [I want to ask a question or provide feedback](#i-want-to-ask-a-question-or-provide-feedback)
   7 - [Adding a new feature](#adding-a-new-feature)
   8 - [PRs](#prs)
   9 - [Dealing with UI tests](#dealing-with-ui-tests)
  10
  11 ## Code of Conduct
  12
  13 We follow the [Rust Official Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct).
  14
  15 ## I want to ask a question or provide feedback
  16
  17 Create [an issue](https://github.com/ouch-org/ouch/issues) or go to [Ouch Discussions](https://github.com/ouch-org/ouch/discussions).
  18
  19 ## Adding a new feature
  20
  21 Before opening the PR, open an issue to discuss your addition, this increases the chance of your PR being accepted.
  22
  23 ## PRs
  24
  25 - Pass all CI checks.
  26 - After opening the PR, add a [CHANGELOG.md] entry.
  27
  28 [CHANGELOG.md]: https://github.com/ouch-org/ouch
  29
  30 ## Dealing with UI tests
  31
  32 We use snapshots to do UI testing and guarantee a consistent output, this way, you can catch accidental changes or see what output changed in the PR diff.
  33
  34 - Run tests with `cargo` normally, or with a filter:
  35
  36 ```sh
  37 cargo test
  38 # Only run UI tests
  39 cargo test -- ui
  40 ```
  41
  42 - If some UI test failed, you should review it:
  43
  44 ```sh
  45 cargo insta review
  46 ```
  47
  48 - After addressing all, you should be able to `git add` and `commit` accordingly.