Skip to content
This repository has been archived by the owner on Aug 13, 2019. It is now read-only.

Latest commit

 

History

History
30 lines (21 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

30 lines (21 loc) · 1.5 KB
Raw

Contributing

Important notes

Please don't edit files in the lib 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.

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.

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, please don't work in your master branch directly.
  2. Add failing tests for the change you want to make. Run grunt test to see the tests fail.
  3. Fix stuff.
  4. Run grunt test to see if the tests pass. Repeat steps 2-4 until done.
  5. Update the documentation to reflect any changes.
  6. Push to your fork and submit a pull request.

Styleguide

We <3 CoffeeScript! So please have a look at this referenced coffeescript styleguide when doing changes to the code.