Skip to content

Commit

Permalink
Merge pull request #107 from wix/aarongreenwald-patch-1
Browse files Browse the repository at this point in the history
Clarify setup instructions
  • Loading branch information
rotemmiz authored Apr 11, 2017
2 parents 7205429 b9844b1 commit 4eb0ebf
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 25,7 @@ npm install -g lerna
npm install -g react-native-cli
```

For all the internal projects (detox, detox-server, detox-cli, demos, test) `lerna` will create symbolic links in `node_modules` instead of `npm` copying the content of the projects. This way, any change you do on any code is there immediatly, no need to update node modules, or copy files between projects.
For all the internal projects (detox, detox-server, detox-cli, demos, test) `lerna` will create symbolic links in `node_modules` instead of `npm` copying the content of the projects. This way, any change you do on any code is there immediately. There is no need to update node modules or copy files between projects.

install `fbsimctl`

Expand All @@ -39,6 39,11 @@ install `xcpretty`
```sh
gem install xcpretty
```
### Installing

```sh
lerna install
```

### Building

Expand All @@ -52,9 57,9 @@ lerna run build
lerna run test
```

Detox JS code is 100% test covered and is set to break the build if covrage gets below, make sure you run unit tests locally before pushing using `lerna run test`
Detox JS code is 100% test covered and is set to break the build if coverage gets below, so make sure you run unit tests (`lerna run test`) locally before pushing.

Alternativley, to JS-only tests, in `detox/detox` directory, run:
Alternatively, to run only the JS tests, run the following from the `detox/detox` directory:

```sh
npm run unit
Expand Down

0 comments on commit 4eb0ebf

Please sign in to comment.