Skip to content

Commit

Permalink
docs: document insta snapshot tool in README (#609)
Browse files Browse the repository at this point in the history
  • Loading branch information
kt3k authored Jul 9, 2024
1 parent 6efe3b3 commit aba1543
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,21 @@ $ deno task build
$ deno task test
```

We use [insta](https://github.com/mitsuhiko/insta) testing tool for taking
snapshots of the html output. If you change the rednering of html output, or
change the fixture files for html testing, you need to update snapshot using
[cargo-insta](https://insta.rs/docs/quickstart/) command.

```
# update snapshots
cargo insta test
# review snapshots
cargo insta review
```

See [the insta docs](https://insta.rs/docs/quickstart/) for more details.

## Contributing

- If you are going to work on an issue, mention so in the issue comments
Expand Down

0 comments on commit aba1543

Please sign in to comment.