Python
/
ruff
mirror of https://github.com/astral-sh/ruff
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(CONTRIBUTING): add instructions how to update the test snapshots (#2412)

This commit is contained in:
Florian Best 2023-02-01 13:44:20 +01:00 committed by GitHub
parent dbd640d90f
commit 7f44ffb55c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@ -50,7 +50,14 @@ cargo test --all # Testing...
These checks will run on GitHub Actions when you open your Pull Request, but running them locally These checks will run on GitHub Actions when you open your Pull Request, but running them locally
will save you time and expedite the merge process. will save you time and expedite the merge process.
If you have `pre-commit` [installed](https://pre-commit.com/#installation) then you can use it to Note that many code changes also require updating the snapshot tests, which is done interactively
after running `cargo test` like so:
```shell
cargo insta review
```
If you have `pre-commit` [installed](https://pre-commit.com/#installation) then you can use it to
assist with formatting and linting. The following command will run the `pre-commit` hooks: assist with formatting and linting. The following command will run the `pre-commit` hooks:
```shell ```shell