Skip to content

Latest commit

 

History

History
executable file
·
27 lines (19 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
27 lines (19 loc) · 1.41 KB
Raw

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 or read the .editorconfig file. Regarding the .editorconfig file you should install in your favourite editor the editorconfig plugin.

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.

  1. Fork and clone the repo.
  2. Run npm install to install all dependencies (including Grunt).
  3. Run grunt to grunt this project.
  4. Run grunt watch to watch all changes.

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. You should not work in your master branch directly.
  2. Fix stuff.
  3. Test changes in actual browser using all the pages in the demo folder.
  4. Update the documentation to reflect any changes.
  5. Push to your fork and submit a pull request.