Skip to content

Commit

Permalink
Update read-me (#2967)
Browse files Browse the repository at this point in the history
* Update read-me

* Update README.md

Co-authored-by: rmccar <[email protected]>

* Update commit line

* Spacing

* Update reference line

* Update README.md

Co-authored-by: rmccar <[email protected]>

* Update README.md

Co-authored-by: rmccar <[email protected]>

---------

Co-authored-by: rmccar <[email protected]>
Co-authored-by: Alessio Venturini <[email protected]>
  • Loading branch information
3 people authored Dec 5, 2023
1 parent 38b1f57 commit ccdb042
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,11 +130,12 @@ Checkout the branch locally and run:

`yarn test-visual:approve` - This will approve the failures/diff caught by the tests.

`yarn test-visual:reference` - This will update the reference images locally on your machine.

`git lfs push --all origin` - First commit the files in the normal way then run the command. This will push the new reference images to Git LFS.

You can then commit and push your changes. The test images that would have been created when you ran `yest test-visual` are gitignored and the new references images will be pushed to Git LFS.
You can then commit and push the updated references and your changes to your branch. The test images that would have been created when you ran `yarn test-visual` are gitignored and the new references images will be pushed to Git LFS.

If your local tests are failing but you have approved them, run `yarn test-visual:reference`. This will update the reference images locally on your machine.

## Build

Expand Down

0 comments on commit ccdb042

Please sign in to comment.