diff options
author | Chris Rebert <code@rebertia.com> | 2015-01-01 06:28:13 +0300 |
---|---|---|
committer | Chris Rebert <code@rebertia.com> | 2015-01-01 06:43:22 +0300 |
commit | 0e97ce1c2f135cf49d5c2f1ddce4ad2576a89b83 (patch) | |
tree | b34e41f6e8a07dd6ac907983a7ff0f496cae6d8f /CONTRIBUTING.md |
initial checkin
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9e3d67c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# 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](https://github.com/caolan/nodeunit) unit tests for the CSS postprocessor via `grunt test`. + +## Modifying the CSS postprocessor code +First, ensure that you have the latest [Node.js](http://nodejs.org/) and [npm](http://npmjs.org/) 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](http://gruntjs.com/getting-started). + +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](https://github.com/cvrebert/mq4-hover-hover-shim/blob/master/LICENSE.txt). |