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

Regarding code style like indentation and whitespace, follow the conventions you see used in the source already (tabs).

PhantomJS

While Grunt can run the included unit tests via PhantomJS, this shouldn't be considered a substitute for the real thing. Please be sure to test the test/*.html unit test file(s) in actual browsers.

Modifying the 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 guide.

Fork and clone the repo.
Run npm install to install all dependencies (including Grunt).
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

Create a new branch, please don't work in your master branch directly. Please pull from the dev branch.
Add failing tests for the change you want to make. Run grunt to see the tests fail.
Fix stuff.
Run grunt to see if the tests pass. Repeat steps 2-4 until done.
Open test/*.html unit test file(s) in actual browser to ensure tests pass everywhere.
Update the documentation to reflect any changes.
Push to your fork and submit a pull request (back to the dev branch).