Skip to content

Commit 19fdef4

Browse files
Adds contributing guide.
So users know how to contribute to the project so their input has a high chance of being accepted upstream.
1 parent db4dd4a commit 19fdef4

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

CONTRIBUTING.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Bug reports
2+
3+
Every piece of software has bugs, and squashing them should always be the priority.
4+
5+
If you spotted an incorrect behavior, knowing the following facts will help fixing it:
6+
7+
* What's your input CSS and expected output?
8+
* What options do you pass to `cleancss`?
9+
* What version of clean-css-cli do you use?
10+
* What operating system do you use?
11+
12+
# Pull requests
13+
14+
We love pull requests! To contribute to clean-css first fork, then clone the repo:
15+
16+
```shell
17+
git clone git@github.com:your-username/clean-css-cli.git
18+
```
19+
20+
Make sure you have node 4.0+ installed so npm can download all dependencies for you:
21+
22+
```shell
23+
npm install
24+
```
25+
26+
Make sure the tests pass:
27+
28+
```shell
29+
npm test
30+
```
31+
32+
Then add tests for your change. Check if tests fail. Make your change. Make the tests pass.
33+
34+
At the end make sure code styling validation passes:
35+
36+
```shell
37+
npm run check
38+
```
39+
40+
Finally push to your fork and [submit a pull request](https://github.com/jakubpawlowicz/clean-css-cli/compare/).
41+
42+
At this point you're waiting for a PR review which should not thake more than a day.
43+
44+
Some things that will increase the chance that your pull request is accepted:
45+
46+
* Write tests.
47+
* Write self-documenting code.
48+
* Squash commits.
49+
* Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

0 commit comments

Comments
 (0)