Skip to content
This repository was archived by the owner on Jan 21, 2024. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (31 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

39 lines (31 loc) · 1.45 KB
Raw

Contributing

Important notes

Grunt will place minified / packaged versions of this plugin in the dist subdirectory. Don't worry about those! 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.

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.

  1. Fork and clone the repo.
  2. Run npm install to install all dependencies (including Grunt).
  3. Run node_modules/.bin/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 local grunt to see the tests fail.
  3. Fix stuff.
  4. grunt again 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.