docs: add description on running tests on single packages

This commit is contained in:
christian-bromann 2018-12-11 12:28:27 +01:00 committed by Adam Bjerstedt
parent 22bbadfaa9
commit a1e09aabd6

View file

@ -41,6 +41,9 @@ In order to set up this project and start contributing follow this step by step
```sh
$ npm run test
# run test for a specific sub project (e.g. webdriver)
$ ./node_modules/.bin/jest ./packages/webdriver/tests
```
It should give you a passing result. Now you can move on to setup your development environment and start working on some code.
@ -70,6 +73,12 @@ If you only work on a single package you can watch only for that one by calling:
$ npm run watch:pkg <package-name>
```
It is also a good idea to run jest in watch mode while developing on a single package to see if changes affect any tests:
```sh
$ ./node_modules/.bin/jest ./packages/<package-name>/tests --watch
```
## Test Your Changes
In order to test certain scenarios this project has a test directory that allows you to run predefined test. It allows you to check your code changes while you are working on it. You find all these files in `/examples`. You find all necessary information [in there](https://github.com/webdriverio/webdriverio/tree/master/examples/README.md).