You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+20-9Lines changed: 20 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
### Environment setup
6
6
7
-
`node.js` and `npm` are needed for using this project. `npm` comes bundled with the `node.js` installer. You can download the `node.js` installer here: https://nodejs.org/download/.
7
+
`node.js` and `npm` are needed for using this project. `npm` comes bundled with the `node.js` installer. You can download the `node.js` installer here: <https://nodejs.org/download/>.
8
8
9
9
Once you have installed `node.js` and `npm`, install the dev dependencies for the project.
10
10
@@ -15,19 +15,22 @@ npm install
15
15
### Using the plugin manually
16
16
17
17
Follow these steps to test your modifications to the plugin manually:
18
+
18
19
- clone this repository
19
20
- install the dependencies
20
21
21
-
Navigate to the root folder from your command line console and run:
22
-
```
23
-
npm install
24
-
```
22
+
Navigate to the root folder from your command line console and run:
23
+
```
24
+
npm install
25
+
```
26
+
25
27
- install the plugin in a React-Native project
26
28
27
-
Navigate to the root folder of your React-Native project from your command line console and run:
28
-
```
29
-
npm install local_path_to_your_clone_of_this_repo
30
-
```
29
+
Navigate to the root folder of your React-Native project from your command line console and run:
30
+
```
31
+
npm install local_path_to_your_clone_of_this_repo
32
+
```
33
+
31
34
- configure the plugin using the steps in the README.md
32
35
- build and run your app on an emulator or device
33
36
@@ -81,20 +84,23 @@ If you would like to pull the plugin from NPM rather than running the tests on t
81
84
#### Default
82
85
83
86
To run all of the unit tests on Android and iOS:
87
+
84
88
```
85
89
npm run test
86
90
```
87
91
88
92
#### iOS
89
93
90
94
To run all of the unit tests on iOS:
95
+
91
96
```
92
97
npm run test:ios
93
98
```
94
99
95
100
#### Android
96
101
97
102
To run all of the unit tests on Android:
103
+
98
104
```
99
105
npm run test:android
100
106
```
@@ -107,26 +113,31 @@ The platforms are ordered as follows, and ran in that order:
107
113
android, ios
108
114
109
115
To run the core unit tests on Android:
116
+
110
117
```
111
118
CORE=true npm run test:android
112
119
```
113
120
114
121
To run all of the unit tests on iOS and pull the plugin from NPM:
122
+
115
123
```
116
124
NPM=true npm run test:ios
117
125
```
118
126
119
127
To run all of the unit tests on Android and iOS without building first:
128
+
120
129
```
121
130
npm run test:fast
122
131
```
123
132
124
133
To run all of the unit tests on iOS and restart the emulators:
134
+
125
135
```
126
136
CLEAN=true npm run test:ios
127
137
```
128
138
129
139
To run the core unit tests on Android and pull the plugin from NPM:
0 commit comments