Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

23 lines (15 loc) · 1.03 KB

Contributing

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Project setup

  1. Fork and clone the repo
  2. $ npm install to install dependencies
  3. $ npm run validate to validate you've got it working
  4. Create a branch for your PR

Testing workflow

Have a look at test/README.md to see how testing works. Run npm run watch:test while developing. Have fun! :)

Editor setup

Please install editorconfig plugin for your preferred editor.

Committing and Pushing changes

We follow a convention for commit messages. This is so that semantic-release can automatically push a new version after a successful master build on Travis. Please follow this convention for your commit messages.