CONTRIBUTING.md

   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 * Do you use clean-css directly or through any of the [plugins](https://github.com/jakubpawlowicz/clean-css#how-to-use-clean-css-with-build-tools)?
   9 * What options do you pass to clean-css / the plugin?
  10 * What version of clean-css do you use?
  11 * What operating system do you use?
  12
  13 # Pull requests
  14
  15 We love pull requests! To contribute to clean-css first fork, then clone the repo:
  16
  17 ```shell
  18 git clone git@github.com:your-username/clean-css.git
  19 ```
  20
  21 Make sure you have node 4.0+ installed so npm can download all dependencies for you:
  22
  23 ```shell
  24 npm install
  25 ```
  26
  27 Make sure the tests pass:
  28
  29 ```shell
  30 npm test
  31 ```
  32
  33 Then add tests for your change. Check if tests fail. Make your change. Make the tests pass.
  34
  35 At the end make sure code styling validation passes:
  36
  37 ```shell
  38 npm run check
  39 ```
  40
  41 Finally push to your fork and [submit a pull request](https://github.com/jakubpawlowicz/clean-css/compare/).
  42
  43 At this point you're waiting for a PR review which should not thake more than a day.
  44
  45 Some things that will increase the chance that your pull request is accepted:
  46
  47 * Write tests.
  48 * Write self-documenting code.
  49 * Squash commits.
  50 * Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).