Skip to content

Commit e208015

Browse files
committed
Add Contributing.md
1 parent 40c3c80 commit e208015

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
2+
## [Code of Conduct](./.github/CODE_OF_CONDUCT.md)
3+
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.
6+
7+
## Semantic Versioning
8+
9+
Purgecss use [SemVer](http://semver.org/) for versioning.
10+
11+
## Sending a Pull Request
12+
13+
**Before submitting a pull request,** please make sure the following is done:
14+
15+
1. Fork [the repository](https://github.com/FullHuman/purgecss-webpack-plugin) and create your branch from `master`.
16+
2. If you've added code that should be tested, add tests!
17+
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+
21+
22+
### Development Workflow
23+
24+
After cloning Purgecss, run `npm i` to fetch its dependencies.
25+
Then, you can run several commands:
26+
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.
33+
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+
36+
### License
37+
38+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
39+
40+
### Aknowledgement
41+
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.

0 commit comments

Comments
 (0)