Skip to content

Commit 2b24329

Browse files
pranshuchittoraematipico
authored andcommitted
feat(md): formats md before committing (#851)
* feat(format): formattes markdowns before commit formattes md files before commit * feat(prettier): adds prettier and formattes markdowns adds prettier as a dependency and formattes markdowns pre-commit
1 parent 11554d6 commit 2b24329

7 files changed

Lines changed: 928 additions & 883 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 123 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,31 @@ work is not in vain.
77

88
Table of Contents
99

10-
- [Issues](#issues)
11-
- [Your first Contribution](#your-first-contribution)
12-
- [Setup](#setup)
13-
- [Using npm](#using-npm)
14-
- [Using yarn](#using-yarn)
15-
- [Running Tests](#running-tests)
16-
- [Using npm](#using-npm-1)
17-
- [Using yarn](#using-yarn-1)
18-
- [Editor Config](#editor-config)
19-
- [Dependencies](#dependencies)
20-
- [Branching Model](#branching-model)
21-
- [Naming a branch](#naming-a-branch)
22-
- [Features](#features)
23-
- [Fixes](#fixes)
24-
- [Testing](#testing)
25-
- [Pull Requests](#pull-requests)
26-
- [Submitting a good Pull Request](#submitting-a-good-pull-request)
27-
- [Commit message](#commit-message)
28-
- [Commit Message Format](#commit-message-format)
29-
- [Migrate with the CLI](#migrate-with-the-cli)
30-
- [How it's being done](#how-its-being-done)
31-
- [Structure of a transform](#structure-of-a-transform)
32-
- [Further Work](#further-work)
33-
- [Contributor License Agreement](#contributor-license-agreement)
34-
- [Documentation](#documentation)
10+
- [Issues](#issues)
11+
- [Your first Contribution](#your-first-contribution)
12+
- [Setup](#setup)
13+
- [Using npm](#using-npm)
14+
- [Using yarn](#using-yarn)
15+
- [Running Tests](#running-tests)
16+
- [Using npm](#using-npm-1)
17+
- [Using yarn](#using-yarn-1)
18+
- [Editor Config](#editor-config)
19+
- [Dependencies](#dependencies)
20+
- [Branching Model](#branching-model)
21+
- [Naming a branch](#naming-a-branch)
22+
- [Features](#features)
23+
- [Fixes](#fixes)
24+
- [Testing](#testing)
25+
- [Pull Requests](#pull-requests)
26+
- [Submitting a good Pull Request](#submitting-a-good-pull-request)
27+
- [Commit message](#commit-message)
28+
- [Commit Message Format](#commit-message-format)
29+
- [Migrate with the CLI](#migrate-with-the-cli)
30+
- [How it's being done](#how-its-being-done)
31+
- [Structure of a transform](#structure-of-a-transform)
32+
- [Further Work](#further-work)
33+
- [Contributor License Agreement](#contributor-license-agreement)
34+
- [Documentation](#documentation)
3535

3636
## Issues
3737

@@ -55,130 +55,130 @@ In case you are suggesting a new feature, we will match your idea with our curre
5555

5656
## Setup
5757

58-
- Install [Node.js](https://nodejs.org/) if you don't have it already.
59-
_Note: Node 6 or greater would be better for "best results"._
60-
- Fork the **webpack-cli** repo at [https://github.com/webpack/webpack-cli](https://github.com/webpack/webpack-cli).
61-
- `git clone <your-clone-url> && cd webpack-cli`
58+
- Install [Node.js](https://nodejs.org/) if you don't have it already.
59+
_Note: Node 6 or greater would be better for "best results"._
60+
- Fork the **webpack-cli** repo at [https://github.com/webpack/webpack-cli](https://github.com/webpack/webpack-cli).
61+
- `git clone <your-clone-url> && cd webpack-cli`
6262

6363
### Using npm
6464

65-
- Install the dependencies and link them:
65+
- Install the dependencies and link them:
6666

67-
```bash
68-
npm install
69-
npm link
70-
npm link webpack-cli
71-
```
67+
```bash
68+
npm install
69+
npm link
70+
npm link webpack-cli
71+
```
7272

73-
- Bootstrap all the submodules before building for the first time
73+
- Bootstrap all the submodules before building for the first time
7474

75-
```bash
76-
npm run bootstrap
77-
npm run build
78-
```
75+
```bash
76+
npm run bootstrap
77+
npm run build
78+
```
7979

8080
### Using yarn
8181

82-
- If you don't have yarn yet:
82+
- If you don't have yarn yet:
8383
84-
```bash
85-
npm install -g yarn
86-
```
84+
```bash
85+
npm install -g yarn
86+
```
8787
88-
- Install the dependencies and link them
88+
- Install the dependencies and link them
8989
90-
```bash
91-
yarn
92-
yarn link
93-
yarn link webpack-cli
94-
```
90+
```bash
91+
yarn
92+
yarn link
93+
yarn link webpack-cli
94+
```
9595
96-
- Bootstrap all the submodules before building for the first time
96+
- Bootstrap all the submodules before building for the first time
9797
98-
```bash
99-
yarn bootstrap
100-
yarn build
101-
```
98+
```bash
99+
yarn bootstrap
100+
yarn build
101+
```
102102
103103
## Running Tests
104104
105105
### Using npm
106106
107-
- Run all the tests with:
107+
- Run all the tests with:
108108
109-
```bash
110-
npm run test
111-
```
109+
```bash
110+
npm run test
111+
```
112112
113-
- Run CLI tests with:
113+
- Run CLI tests with:
114114
115-
```bash
116-
npm run test:cli
117-
```
115+
```bash
116+
npm run test:cli
117+
```
118118
119-
- Run tests of all packages:
119+
- Run tests of all packages:
120120
121-
```bash
122-
npm run test:packages
123-
```
121+
```bash
122+
npm run test:packages
123+
```
124124
125-
- Test a single CLI test case:
125+
- Test a single CLI test case:
126126
127-
```bash
128-
npx jest path/to/my-test.js
129-
```
127+
```bash
128+
npx jest path/to/my-test.js
129+
```
130130
131-
- You can also install jest globally and run tests without npx:
131+
- You can also install jest globally and run tests without npx:
132132
133-
```bash
134-
npm i -g jest
135-
jest path/to/my-test.js
136-
```
133+
```bash
134+
npm i -g jest
135+
jest path/to/my-test.js
136+
```
137137
138-
- You can run the linters:
138+
- You can run the linters:
139139
140-
```bash
141-
npm run lint
142-
```
140+
```bash
141+
npm run lint
142+
```
143143
144144
### Using yarn
145145
146-
- Run all the tests with:
146+
- Run all the tests with:
147147
148-
```bash
149-
yarn test
150-
```
148+
```bash
149+
yarn test
150+
```
151151
152-
- Run CLI tests with:
152+
- Run CLI tests with:
153153
154-
```bash
155-
yarn test:cli`
156-
```
154+
```bash
155+
yarn test:cli`
156+
```
157157
158-
- Run tests of all packages:
158+
- Run tests of all packages:
159159
160-
```bash
161-
yarn test:packages
162-
```
160+
```bash
161+
yarn test:packages
162+
```
163163
164-
- Test a single CLI test case:
164+
- Test a single CLI test case:
165165
166-
```bash
167-
yarn jest path/to/my-test.js
168-
```
166+
```bash
167+
yarn jest path/to/my-test.js
168+
```
169169
170-
- You can also install jest globally and run tests:
170+
- You can also install jest globally and run tests:
171171
172-
```bash
173-
yarn global add jest
174-
jest path/to/my-test.js
175-
```
172+
```bash
173+
yarn global add jest
174+
jest path/to/my-test.js
175+
```
176176
177-
- You can run the linters:
177+
- You can run the linters:
178178
179-
```bash
180-
yarn lint
181-
```
179+
```bash
180+
yarn lint
181+
```
182182
183183
## Editor Config
184184
@@ -198,15 +198,15 @@ We base our branching model on [git flow](http://nvie.com/posts/a-successful-git
198198

199199
Making a branch in your fork for your contribution is helpful in the following ways:
200200

201-
- It allows you to submit more than one contribution in a single PR.
202-
- It allows us to identify what your contribution is about from the branch name.
201+
- It allows you to submit more than one contribution in a single PR.
202+
- It allows us to identify what your contribution is about from the branch name.
203203

204204
You will want to checkout the `master` branch locally before creating your new branch.
205205

206206
There are two types of branches:
207207

208-
- Feature
209-
- Bugfix
208+
- Feature
209+
- Bugfix
210210

211211
### Features
212212

@@ -237,9 +237,9 @@ In case you've got a small change in most of the cases, your pull request would
237237

238238
## Submitting a good Pull Request
239239

240-
- Write tests
241-
- Follow the existing coding style
242-
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
240+
- Write tests
241+
- Follow the existing coding style
242+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
243243

244244
## Commit message
245245

@@ -265,15 +265,15 @@ format that includes a **type** and a **subject**:
265265
266266
This is the list of _type_ of commits that we accept:
267267
268-
- ast
269-
- break
270-
- chore
271-
- cli
272-
- docs
273-
- feat
274-
- fix
275-
- misc
276-
- tests
268+
- ast
269+
- break
270+
- chore
271+
- cli
272+
- docs
273+
- feat
274+
- fix
275+
- misc
276+
- tests
277277
278278
The **header** is mandatory.
279279
@@ -344,8 +344,8 @@ It takes the input file given as parameter and uses jest to create a snapshot of
344344
This is still in a very raw form. We'd like to take this as close to a truly useful tool as possible.
345345
We will still need to
346346
347-
- Support all kinds of webpack configuration(made using merge tools)
348-
- Test these transforms against real-world configurations.
347+
- Support all kinds of webpack configuration(made using merge tools)
348+
- Test these transforms against real-world configurations.
349349
350350
## Contributor License Agreement
351351

0 commit comments

Comments
 (0)