Please don't edit files in the
dist subdirectory as they are generated via grunt. You'll find source code in the
Regarding code style like indentation and whitespace, follow the conventions you see used in the source already.
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.
See the Why does grunt complain that PhantomJS isn't installed? guide in the Grunt FAQ for help with installing or troubleshooting PhantomJS.
Modifying the code
Test that grunt is installed globally by running
grunt --version at the command-line. If grunt isn't installed globally, run
npm install -g grunt to install the latest version. You may need to run
sudo npm install -g grunt.
Note that in Windows, you may have to run
grunt.cmd instead of
- Fork and clone the repo.
npm installto install all dependencies (including grunt).
gruntto 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
- Add failing tests for the change you want to make. Run
gruntto see the tests fail.
- Fix stuff.
gruntto see if the tests pass. Repeat steps 2-4 until done.
test/*.htmlunit 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.