Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (25 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

37 lines (25 loc) · 1.62 KB

Contributing

Code style

Two space indent

Modifying the code

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

Test that gulp is installed globally by running grunt -v at the command-line. If gulp isn't installed globally, run npm install -g gulp to install the latest version.

  • Fork and clone the repo.
  • Run npm install and bower install to install all dev dependencies (including grunt).
  • Modify the *.coffee file.
  • Run gulp to build this project.

Assuming that you don't see any red, you're ready to go. Just be sure to run gulp 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 gulp to see the tests fail.
  3. Fix stuff.
  4. Run gulp to see if the tests pass. Repeat steps 2-4 until done.
  5. Open _SpecRunner.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.

notes

Please don't edit files in the dist subdirectory and *.js files in src as they are generated via gulp.
You'll find source code in the src subdirectory!
use bower install or component install to install dependencies first.

PhantomJS

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 _SpecRunner.html unit test file(s) in actual browsers.