ouch/CONTRIBUTING.md

Thanks for your interest in contributing to ouch!

Table of contents:

• Code of Conduct
• I want to ask a question or provide feedback
• Adding a new feature
• PRs
• Dealing with UI tests

Code of Conduct

We follow the Rust Official Code of Conduct.

I want to ask a question or provide feedback

Create an issue or go to Ouch Discussions.

Adding a new feature

Before opening the PR, open an issue to discuss your addition, this increases the chance of your PR being accepted.

PRs

• Pass all CI checks.
• After opening the PR, add a CHANGELOG.md entry.

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.

• Run tests with cargo normally, or with a filter:

cargo test
# Or, if you only want to run UI tests
# cargo test -- ui

• If some UI test failed, you should review them (requires cargo install cargo-insta):

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.