Skip to content

Commit 3798ca6

Browse files
author
Matej Lednicky
committed
fix(DIST-589): Update README
Use "fix" in commit message to trigger release Github Actions workflow.
1 parent 1332e87 commit 3798ca6

File tree

2 files changed

+20
-17
lines changed

2 files changed

+20
-17
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,26 @@ To work with Embed as a developer:
4646
yarn clean # delete directories with built files (./dist and ./lib)
4747
```
4848

49+
## Tests
50+
51+
In order to run visual tests, you need an applitools key.
52+
53+
- Add a `.env` file in your root, you can look at the `.env.example`
54+
- Add your api key `EYES_API_KEY=HERE_GOES_YOUR_KEY`
55+
- (Optional) You can add the url, by default the url is `http://localhost:8080`
56+
- Start the server `yarn start`
57+
- Run the tests with `yarn test`
58+
- - This command will run all the tests. That means **unit tests**, **integration tests** and **visual tests**
59+
60+
This is the list of all the test commands, if you want to run them one by one:
61+
62+
```
63+
yarn lint # Run eslint and prettier check
64+
yarn test:unit # Runs unit tests
65+
yarn test:functional # Runs functional tests with Cypress
66+
yarn test:visual # Runs visual tests with Cypress and Applitools
67+
```
68+
4969
## Development suggestions
5070

5171
<!-- TODO: add any "wishlist" items you hope someone might develop -->

README.md

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -229,23 +229,6 @@ Although we have no hard limit, we recommend having a height of at least 350px.
229229

230230
We use `position: fixed` to position our modal relative to its containing block established by the viewport. If one of the modal ancestors has a `transform`, `perspective`, or `filter` css property set to something other than `none` the positioning will be relative to it and probably not visible by the user.
231231

232-
## Tests
233-
234-
In order to run visual tests, you need an applitools key.
235-
236-
- Add a `.env` file in your root, you can look at the `.env.example`
237-
- Add your api key `EYES_API_KEY=HERE_GOES_YOUR_KEY`
238-
- (Optional) You can add the url, by default the url is `http://localhost:8080`
239-
- Start the server `yarn start`
240-
- Run the tests with `yarn test`
241-
- - This command will run all the tests. That means **unit tests**, **integration tests** and **visual tests**
242-
243-
This is the list of all the test commands, if you want to run them one by one:
244-
245-
- `yarn test:unit` --> Runs unit tests
246-
- `yarn test:functional` --> Runs functional tests with Cypress
247-
- `yarn test:visual` --> Runs visual tests with Cypress and Applitools
248-
249232
## Feedback
250233

251234
We are always open to your [feedback](https://tfproductops.typeform.com/to/RGpsdc).

0 commit comments

Comments
 (0)