Browse Source

Update CONTRIBUTING.md

Daniel Zlotin 7 years ago
parent
commit
f3b5f622ea
1 changed files with 8 additions and 8 deletions
  1. 8
    8
      CONTRIBUTING.md

+ 8
- 8
CONTRIBUTING.md View File

@@ -3,10 +3,10 @@
3 3
 | Folder | Description |
4 4
 | ------ | ----------- |
5 5
 | `lib` | The project itself composed of: |
6
-| `.../android` | android sources and unit tests |
7
-| `.../ios` | iOS sources and unit tests |
8
-| `.../src` | javascript sources and unit tests |
9
-| `.../src/index.js` | the entry point for `import Navigation from 'react-native-navigation'` |
6
+| `lib/android` | android sources and unit tests |
7
+| `lib/ios` | iOS sources and unit tests |
8
+| `lib/src` | javascript sources and unit tests |
9
+| `lib/src/index.js` | the entry point for `import Navigation from 'react-native-navigation'` |
10 10
 | `e2e` | [detox](https://github.com/wix/detox) iOS e2e tests (in the future, once detox supports it, we will have android e2e here as well) |
11 11
 | `AndroidE2E` | Android e2e tests using native uiautomator |
12 12
 | `playground` | The end-user project all e2e tests run against. Contains its own `src`, `android` and `ios`. Does not have its own package.json, depends on the local `<root>/lib` in order not to go through npm. |
@@ -64,12 +64,12 @@ brew tap facebook/fb && brew install fbsimctl
64 64
 | `yarn clean` | cleans all build directories, stops packager, fixes flakiness by removing watchman cache, etc. |
65 65
 | `yarn start` | starts the react-native packager for local debugging |
66 66
 | `yarn xcode` | for convenience, opens xcode in this project |
67
-| `yarn install-android`  |  builds playground debug/release version and installs on running android devices/emulators. <br> **Options:** `-- release` `-- debug` |
67
+| `yarn install-android`  |  builds playground debug/release version and installs on running android devices/emulators. <br> **Options:** `-- release` |
68 68
 | `yarn uninstall-android` | uninstalls playground from running android devices/simulators |
69 69
 | `yarn test-js` | runs javascript tests and coverage report |
70 70
 | `yarn test-watch` | runs javascript tests in watch mode (can also use the provided wallaby config) |
71
-| `yarn test-unit-ios` | runs ios unit tests in debug/release <br> **Options:** `-- release` `-- debug` |
72
-| `yarn test-unit-android` | runs android unit tests in debug/release <br> **Options:** `-- release` `-- debug` |
71
+| `yarn test-unit-ios` | runs ios unit tests in debug/release <br> **Options:** `-- release` |
72
+| `yarn test-unit-android` | runs android unit tests in debug/release <br> **Options:** `-- release` |
73 73
 | `yarn test-e2e-ios` | runs the ios e2e suite (with detox) in debug/release |
74
-| `yarn test-e2e-android` | runs the android e2e suite (with uiautomator) in debug/release on running devices/emulators <br> **Options:** `-- release` `-- debug` |
74
+| `yarn test-e2e-android` | runs the android e2e suite (with uiautomator) in debug/release on running devices/emulators <br> **Options:** `-- release` |
75 75
 | `yarn test-all` | runs all tests in parallel |