Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

27 lines (19 loc) · 1.27 KB
Raw

Contributing

Important notes

Please don't edit files in the dist subdirectory as they are generated via gulp. 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 gulp is installed globally by running gulp --version at the command-line. If gulp isn't installed globally, run npm install -g gulp to install the latest version.

  1. Fork and clone the repo.
  2. Run npm install to install all dependencies (including gulp).
  3. 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. Update the documentation to reflect any changes.
  6. Push to your fork and submit a pull request.