Skip to content

Commit 77bb0a8

Browse files
committed
fix: update formatting and improve clarity in CONTRIBUTING.md
1 parent 2d69350 commit 77bb0a8

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### Environment setup
66

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/>.
88

99
Once you have installed `node.js` and `npm`, install the dev dependencies for the project.
1010

@@ -15,19 +15,22 @@ npm install
1515
### Using the plugin manually
1616

1717
Follow these steps to test your modifications to the plugin manually:
18+
1819
- clone this repository
1920
- install the dependencies
2021

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+
2527
- install the plugin in a React-Native project
2628

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+
3134
- configure the plugin using the steps in the README.md
3235
- build and run your app on an emulator or device
3336

@@ -81,20 +84,23 @@ If you would like to pull the plugin from NPM rather than running the tests on t
8184
#### Default
8285

8386
To run all of the unit tests on Android and iOS:
87+
8488
```
8589
npm run test
8690
```
8791

8892
#### iOS
8993

9094
To run all of the unit tests on iOS:
95+
9196
```
9297
npm run test:ios
9398
```
9499

95100
#### Android
96101

97102
To run all of the unit tests on Android:
103+
98104
```
99105
npm run test:android
100106
```
@@ -107,26 +113,31 @@ The platforms are ordered as follows, and ran in that order:
107113
android, ios
108114

109115
To run the core unit tests on Android:
116+
110117
```
111118
CORE=true npm run test:android
112119
```
113120

114121
To run all of the unit tests on iOS and pull the plugin from NPM:
122+
115123
```
116124
NPM=true npm run test:ios
117125
```
118126

119127
To run all of the unit tests on Android and iOS without building first:
128+
120129
```
121130
npm run test:fast
122131
```
123132

124133
To run all of the unit tests on iOS and restart the emulators:
134+
125135
```
126136
CLEAN=true npm run test:ios
127137
```
128138

129139
To run the core unit tests on Android and pull the plugin from NPM:
140+
130141
```
131142
NPM=true CORE=true npm run test:android
132143
```

0 commit comments

Comments
 (0)