CONTRIBUTING.md

   1 Thanks for your interest in contributing to `ouch`!
   2
   3 # Code of Conduct
   4
   5 We follow the [Rust Official Code of Conduct](https://www.rust-lang.org/policies/code-of-conduct).
   6
   7 # I want to ask a question or provide feedback
   8
   9 Create [an issue](https://github.com/ouch-org/ouch/issues) or go to [Ouch Discussions](https://github.com/ouch-org/ouch/discussions).
  10
  11 # Adding a brand new feature
  12
  13 Before opening the PR, open an issue to discuss your addition, this increases the chance of your PR being accepted.
  14
  15 # PRs
  16
  17 - Pass all CI checks.
  18 - After opening the PR, add a [CHANGELOG.md] entry.
  19
  20 # Updating UI tests
  21
  22 In case you need to update the UI tests.
  23
  24 - Run tests with `insta` to create the new snapshots:
  25
  26 ```sh
  27 cargo insta review # or
  28 cargo insta review -- ui # useful filter
  29 ```
  30
  31 - Now, review the diffs you just generated.
  32
  33 ```sh
  34 cargo insta review
  35 ```
  36
  37 - You can commit them now.
  38
  39 [CHANGELOG.md]: https://github.com/ouch-org/ouch