Skip to content

Commit aba1543

Browse files
authored
docs: document insta snapshot tool in README (#609)
1 parent 6efe3b3 commit aba1543

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,21 @@ $ deno task build
3636
$ deno task test
3737
```
3838

39+
We use [insta](https://github.com/mitsuhiko/insta) testing tool for taking
40+
snapshots of the html output. If you change the rednering of html output, or
41+
change the fixture files for html testing, you need to update snapshot using
42+
[cargo-insta](https://insta.rs/docs/quickstart/) command.
43+
44+
```
45+
# update snapshots
46+
cargo insta test
47+
48+
# review snapshots
49+
cargo insta review
50+
```
51+
52+
See [the insta docs](https://insta.rs/docs/quickstart/) for more details.
53+
3954
## Contributing
4055

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

0 commit comments

Comments
 (0)