Please don’t edit files in the dist subdirectory as they are generated via Gulp. You’ll find source code in the src subdirectory!
Regarding code style like indentation and whitespace, follow the conventions you see used in the source already.
While Gulp 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.
First, ensure that you have the latest Node.js and npm installed.
Test that Gulp and Bower are installed by running gulp --version and bower --version. If the commands aren’t found, run npm install -g gulp bower. For more information about installing the tools, see gulpjs.com or bower.io respectively.
- Fork and clone the repo.
- Run
npm installto install all build dependencies. - Run
bower installto install the front-end dependencies. - Run
gulpto build this project.
Assuming that you don’t see any errors, you’re ready to go. Just be sure to run gulp after making any changes, to ensure that nothing is broken.
- Create a new branch, please don’t work in your
masterbranch directly. - Add failing tests for the change you want to make. Run
gulpto see the tests fail. - Fix stuff.
- Run
gulpto see if the tests pass. Repeat steps 2-4 until done. - Open
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.