Skip to content

Commit f0b3651

Browse files
committed
docs: add testing instructions
1 parent 35f9150 commit f0b3651

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,22 @@ To fix formatting errors, run the following:
6161
yarn lint --fix
6262
```
6363

64+
### Testing
65+
6466
Remember to add tests for your change if possible. Run the unit tests by:
6567

68+
For testing we use the example app which has a component [TestResults.tsx](./example/src/components/TestResults.tsx) that runs the tests.
69+
70+
If you add a new test, you need to add it to the [tests](./example/src/tests) folder and import it in the [TestResults.tsx](./example/src/components/TestResults.tsx) component.
71+
72+
Verify that the results are the same in the web, iOS and Android. Basically in all environments all tests should pass.
73+
6674
```sh
67-
yarn test
75+
# Web
76+
yarn test:e2e:web
77+
# iOS
78+
maestro test e2e-tests/maestro-flow-ios.yml
79+
# Android (see Github Actions workflow for more details)
6880
```
6981

7082
### Commit message convention

0 commit comments

Comments
 (0)