Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 1.88 KB
Raw

Contributing

Important notes

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

Code style

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

Modifying the code

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

Test that Grunt's CLI and Bower are installed by running grunt --version and bower --version. If the commands aren't found, run npm install -g grunt-cli bower. For more information about installing the tools, see the getting started with Grunt guide or bower.io respectively.

  1. Fork and clone the repo.
  2. Run npm install to install all build dependencies (including Grunt).
  3. Run bower install to install the front-end dependencies.
  4. 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.

Useful tasks:

  1. grunt dist - Create a new version of the 'dist' folder and recompile everything from source.
  2. grunt demo - Copies all demo dependencies into demo folder, i.e when updating to latest Bootstrap
  3. jekyll build - Run the documentation generator.

Submitting pull requests

  1. Create a new branch, please don't work in your master branch directly.
  2. 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. Open test/*.html unit test file(s) in actual browser to ensure tests pass everywhere.
  6. Update the documentation to reflect any changes.
  7. Push to your fork and submit a pull request.