Skip to content
This repository was archived by the owner on Sep 6, 2018. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (23 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

33 lines (23 loc) · 1.66 KB

Contributing

Important notes

Please don't edit files in the dist subdirectory as they are generated via Grunt. You'll find source code in the src subdirectory!

Code style

The project's coding style is laid out in the JSHint, ESLint, and JSCS configurations.

Nodeunit

Grunt can run the included Nodeunit-based unit tests for the CSS postprocessor via grunt test.

Modifying the CSS postprocessor code

First, ensure that you have the latest Node.js and npm installed.

Test that Grunt's CLI is installed by running grunt --version. If the command isn't found, run npm install -g grunt-cli. For more information about installing Grunt, see the getting started with Grunt guide.

  1. Fork and clone the repo.
  2. Run npm install to install all build dependencies (including Grunt).
  3. Run grunt to grunt this project.

Assuming that you don't see any red, you're ready to go. Just be sure to run grunt after making any changes, to ensure that nothing is broken.

Submitting pull requests

  1. Create a new branch, please don't work in your master branch directly.
  2. If you're modifying the CSS postprocessor, add failing tests for the change you want to make. Run grunt to see the tests fail.
  3. Fix stuff.
  4. Run grunt to see if the tests pass. Repeat steps 2-4 until done.
  5. Update the documentation to reflect any changes.
  6. Push to your fork and submit a pull request.

Licensing

By contributing your code, you agree to license your contribution under the MIT License.