Skip to content

Commit 47fcd7f

Browse files
committedMar 10, 2019
docs(contributing): improve formatting
1 parent ccec130 commit 47fcd7f

File tree

1 file changed

+38
-17
lines changed

1 file changed

+38
-17
lines changed
 

‎.github/CONTRIBUTING.md

+38-17
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ In case you are suggesting a new feature, we will match your idea with our curre
3636

3737
* Install the dependencies and link them:
3838

39-
```bash
40-
npm install
41-
npm link
42-
npm link webpack-cli
43-
```
39+
```bash
40+
npm install
41+
npm link
42+
npm link webpack-cli
43+
```
4444

4545
* Bootstrap all the submodules before building for the first time
4646

@@ -50,10 +50,16 @@ npm link webpack-cli
5050
```
5151

5252
* Run all the tests with:
53-
- `npm run test`
53+
54+
```bash
55+
npm run test
56+
```
5457

5558
* To test a single CLI (flag) test case:
56-
- `BIN_TEST_CASES_GREP=/myCase jest test/BinTestCases.test.js`
59+
60+
```bash
61+
BIN_TEST_CASES_GREP=/myCase jest test/BinTestCases.test.js`
62+
```
5763

5864
* To test a single CLI (other type of) test case:
5965
- `npx jest path/to/my-test.js`
@@ -63,18 +69,24 @@ npm link webpack-cli
6369
- `jest path/to/my-test.js`
6470

6571
* To test linting:
66-
- `npm run lint && npm run tslint`
72+
```bash
73+
npm run lint && npm run tslint
74+
```
6775

6876
### Setup with yarn
6977
* If you don't have yarn yet:
70-
- `npm install -g yarn`
78+
79+
```bash
80+
npm install -g yarn
81+
```
82+
7183
* Install the dependencies and link them
7284
73-
```bash
74-
yarn
75-
yarn link
76-
yarn link webpack-cli
77-
```
85+
```bash
86+
yarn
87+
yarn link
88+
yarn link webpack-cli
89+
```
7890
7991
* Bootstrap all the submodules before building for the first time
8092
@@ -84,16 +96,25 @@ yarn link webpack-cli
8496
```
8597
8698
* Run all the tests with:
87-
- `yarn test`
99+
100+
```bash
101+
yarn test
102+
```
88103
89104
* To test a single CLI (flag) test case:
90-
- `BIN_TEST_CASES_GREP=/myCase jest test/BinTestCases.test.js`
105+
106+
```bash
107+
BIN_TEST_CASES_GREP=/myCase jest test/BinTestCases.test.js
108+
```
91109
92110
* To test a single CLI (other type of) test case:
93111
- `yarn jest path/to/my-test.js`
94112
95113
* To test linting:
96-
- `yarn lint && yarn tslint`
114+
115+
```bash
116+
yarn lint && yarn tslint
117+
```
97118
98119
## Editor Config
99120

0 commit comments

Comments
 (0)
Please sign in to comment.