Sfoglia il codice sorgente

Use table and omit “run” in yarn commands (#1233)

June Domingo 7 anni fa
parent
commit
2c7021a845
1 ha cambiato i file con 27 aggiunte e 39 eliminazioni
  1. 27
    39
      CONTRIBUTING.md

+ 27
- 39
CONTRIBUTING.md Vedi File

@@ -1,19 +1,17 @@
1 1
 # Folder Structure
2
-* `lib`: The project itself composed of:</br>
3
-`lib/android`: android sources and unit tests</br>
4
-`lib/ios`: iOS sources and unit tests</br>
5
-`lib/src`: javascript sources and unit tests</br>
6
-`lib/src/index.js`: the entry point for `import Navigation from 'react-native-navigation'`
7
-
8
-* `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)
9
-
10
-* `AndroidE2E`: Android e2e tests using native uiautomator
11
-
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.
13
-
14
-* `integration`: misc javascript integration tests
15
-* `scripts`: all scripts
16 2
 
3
+| Folder | Description |
4
+| ------ | ----------- |
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'` |
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
+| `AndroidE2E` | Android e2e tests using native uiautomator |
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. |
13
+| `integration` | misc javascript integration tests |
14
+| `scripts` | all scripts |
17 15
 
18 16
 # Running locally
19 17
 
@@ -60,28 +58,18 @@ brew tap facebook/fb && brew install fbsimctl
60 58
 
61 59
 ### Scripts
62 60
 
63
-`yarn install`: installs dependencies
64
-
65
-`yarn run clean`: cleans all build directories, stops packager, fixes flakiness by removing watchman cache, etc.
66
-
67
-`yarn run start`: starts the react-native packager for local debugging
68
-
69
-`yarn run xcode`: for convenience, opens xcode in this project
70
-
71
-`yarn run install-android [-- release]`: builds playground debug/release version and installs on running android devices/emulators
72
-
73
-`yarn run uninstall-android`: uninstalls playground from running android devices/simulators
74
-
75
-`yarn run test-js`: runs javascript tests and coverage report
76
-
77
-`yarn run test-watch`: runs javascript tests in watch mode (can also use the provided wallaby config)
78
-
79
-`yarn run test-unit-ios [-- release]`: runs ios unit tests in debug/release
80
-
81
-`yarn run test-unit-android [-- release]`: runs android unit tests in debug/release
82
-
83
-`yarn run test-e2e-ios [-- release]`: runs the ios e2e suite (with detox) in debug/release
84
-
85
-`yarn run test-e2e-android [-- release]`: runs the android e2e suite (with uiautomator) in debug/release on running devices/emulators
86
-
87
-`yarn run test-all`: runs all tests in parallel
61
+| Command | Description |
62
+| ------- | ----------- |
63
+| `yarn install` | installs dependencies |
64
+| `yarn clean` | cleans all build directories, stops packager, fixes flakiness by removing watchman cache, etc. |
65
+| `yarn start` | starts the react-native packager for local debugging |
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` |
68
+| `yarn uninstall-android` | uninstalls playground from running android devices/simulators |
69
+| `yarn test-js` | runs javascript tests and coverage report |
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` |
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` |
75
+| `yarn test-all` | runs all tests in parallel |