Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (22 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 1.5 KB
Raw

Contributing

You want to contribute to this project; thank you!

Important notes

Don't edit files in the dist directory, they're generated via Grunt. Find source code in the src directory.

Code style

Please follow the conventions you see used in the source already.

PhantomJS

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.

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. Run grunt watch while you work to monitor for test failures or linting mistakes.

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.
  3. Fix stuff.
  4. Open test/*.html unit test file(s) in actual browser to ensure tests pass everywhere.
  5. Update the documentation to reflect any changes.
  6. Push to your fork and submit a pull request.