Skip to content

Latest commit

 

History

History
31 lines (22 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

31 lines (22 loc) · 2.03 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.

PhantomJS

While grunt runs 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 but please note that the some of the tests will fail in a browser unless your time zone is Europe/London. The gruntfile.js will however correctly set the time zone for PhantomJS to ensure that the tests run during build will always use the expected time zone, regardless of your location. Remember, though, that it's only the tests that expect to be in Europe/London - the plugin should work anywhere.

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 to see the tests fail.
  3. Fix stuff.
  4. Run grunt 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.