Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (18 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

28 lines (18 loc) · 1.06 KB
Raw

Contributing

Important notes

Please don't edit files in the dist subdirectory as they are generated via npm-scripts. 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

Ensure that you have Node.js and npm installed. The best way to do it is through NVM.

  1. Fork and clone the repo.
  2. Run npm install to install all dependencies (including grunt).
  3. Run npm run serve to develop while watching changes
  4. Run npm run dist to ensure files are linted/tested and that the project builds properly

Assuming that you don't see any red, you're ready to go.

Submitting pull requests

  1. Create a new branch, please don't work in your master branch directly.
  2. Fix stuff.
  3. Add examples if you are adding a new feature.
  4. Run npm run dist to see if there are warnings/errors.
  5. Push to your fork and submit a pull request.