Skip to content

Commit b74644c

Browse files
authored
Add section about updating reference snapshots (#6733)
1 parent b44f2c3 commit b74644c

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,18 @@ Running the end to end tests in headful mode will trigger something like the fol
9494

9595
![playwight-headed-demo](https://user-images.githubusercontent.com/591645/141274633-ca9f9c2f-eef6-430e-9228-a35827f8133d.gif)
9696

97+
### Updating reference snapshots
98+
99+
Often a PR might make changes to the user interface, which can cause the visual regression tests to fail.
100+
101+
If you want to update the reference snapshots while working on a PR you can post the following sentence as a GitHub comment:
102+
103+
```
104+
bot please update playwright snapshots
105+
```
106+
107+
This will trigger a GitHub Action that will run the UI tests automatically and push new commits to the branch if the reference snapshots have changed.
108+
97109
## Code Styling
98110

99111
All non-python source code is formatted using [prettier](https://prettier.io) and python source code is formatted using [black](https://github.com/psf/black)s

0 commit comments

Comments
 (0)