Skip to content

Improve CONTRIBUTING.md #845

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcospb19 merged 1 commit into from
Jul 15, 2025
Merged

Improve CONTRIBUTING.md #845

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ Before opening the PR, open an issue to discuss your addition, this increases th

[CHANGELOG.md]: https://github.com/ouch-org/ouch

### CI Tests

The CI tests will run for a combination of features, `--no-default-features` will also be tested.

## Dealing with UI tests

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.
Expand All @@ -46,3 +50,5 @@ cargo insta review
```

- After addressing all, you should be able to `git add` and `commit` accordingly.

NOTE: Sometimes, you'll have to run these two commands multiple times.