Update the playground README.md (#93)

This commit is contained in:
Fulop 2022-03-03 09:46:01 +01:00 committed by GitHub
parent 5f01ef0821
commit fb7467862b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -25,7 +25,7 @@ src/
Simply run `yarn run serve` in this folder to start the dev server.
There are some shared playgrounds in `src/shared` which are committed to the repo. You can make your own playgrounds in `src/personal` which will be `.gitignore`d. Each
There are some shared playgrounds in `src/shared` which are committed to the repo. You can make your own playgrounds in `src/personal` which will be `.gitignore`d. Note that every playground must include an entry file called `index.tsx` (as you see in the [Directory structure section](#directory-structure)).
## How to write and run end-to-end tests
@ -55,4 +55,4 @@ $ yarn playwright codegen http://localhost:8080/tests/[playground-name] # run th
We're currently using [percy](https://percy.io) for visual regression testing. These tests run only the the [CI](../../.github/workflows/main.yml) using [Github actions](https://github.com/theatre-js/theatre/actions). Look at the example at [`src/tests/setting-static-props/test.e2e.ts`](src/tests/setting-static-props/test.e2e.ts) for an example of recording and diffing a screenshot.
Please note that we haven't figured out the best practices for visual regression testing yet, so if the setup isn't optimal, please let us know.
Please note that we haven't figured out the best practices for visual regression testing yet, so if the setup isn't optimal, please let us know.