Skip to content
This repository was archived by the owner on Feb 1, 2020. It is now read-only.

Commit 8f4d6e1

Browse files
committed
update CONTRIBUTING.md
1 parent 74efa14 commit 8f4d6e1

File tree

1 file changed

+23
-18
lines changed

1 file changed

+23
-18
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
21
## [Code of Conduct](./.github/CODE_OF_CONDUCT.md)
32

4-
FullHuman has adopted the Contributor Covenant Code of Conduct for all of its project.
5-
Please read the text so that you understand how to conduct while contributing to this project.
3+
FullHuman has adopted the Contributor Covenant Code of Conduct for all of its
4+
project. Please read the text so that you understand how to conduct while
5+
contributing to this project.
66

77
## Semantic Versioning
88

@@ -12,31 +12,36 @@ Purgecss use [SemVer](http://semver.org/) for versioning.
1212

1313
**Before submitting a pull request,** please make sure the following is done:
1414

15-
1. Fork [the repository](https://github.com/FullHuman/purgecss-webpack-plugin) and create your branch from `master`.
15+
1. Fork [the repository](https://github.com/FullHuman/purgecss-webpack-plugin)
16+
and create your branch from `master`.
1617
2. If you've added code that should be tested, add tests!
1718
3. If you've changed APIs, update the documentation.
18-
4. Ensure the test suite passes (`npm test`).
19-
5. Make sure your code lints (`npm run lint`).
20-
19+
<!-- 4. Ensure the test suite passes (`npm test`). -->
20+
4. Make sure your code lints (`npm run lint`).
2121

2222
### Development Workflow
2323

24-
After cloning Purgecss, run `npm i` to fetch its dependencies.
25-
Then, you can run several commands:
24+
After cloning Purgecss, run `npm i` to fetch its dependencies. Then, you can run
25+
several commands:
2626

27-
- `npm run dev` will build cjs and es module of Purgecss in the `lib` folder and watch for changes.
28-
- `npm run lint` checks the code style.
29-
- `npm test` runs the complete test suite.
30-
- `npm test -- --watch` runs an interactive test watcher.
31-
- `npm test <pattern>` runs tests with matching filenames.
32-
- `npm run build` creates the cjs and es module of Purgecss in the `lib` folder.
27+
* `npm run dev` will build cjs and es module of Purgecss in the `lib` folder and
28+
watch for changes.
29+
<!-- - `npm run lint` checks the code style.
30+
* `npm test` runs the complete test suite.
31+
* `npm test -- --watch` runs an interactive test watcher.
32+
* `npm test <pattern>` runs tests with matching filenames. -->
33+
* `npm run build` creates the cjs and es module of Purgecss in the `lib` folder.
3334

34-
Make sure that your pull request contains unit tests for any new functionality. This way we can ensure that we don't break your code in the future.
35+
Make sure that your pull request contains unit tests for any new functionality.
36+
This way we can ensure that we don't break your code in the future.
3537

3638
### License
3739

38-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
40+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
41+
for details.
3942

4043
### Aknowledgement
4144

42-
This CONTRIBUTING.md is based on the [react](https://github.com/facebook/react) [how-to-contribute.md](https://github.com/facebook/react/blob/master/docs/contributing/how-to-contribute.md) file.
45+
This CONTRIBUTING.md is based on the [react](https://github.com/facebook/react)
46+
[how-to-contribute.md](https://github.com/facebook/react/blob/master/docs/contributing/how-to-contribute.md)
47+
file.

0 commit comments

Comments
 (0)