Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.25 KB
Raw

CONTRIBUTING

Contributions are welcome, and are accepted via pull requests. Please review these guidelines before submitting any pull requests.

Guidelines

  • Please ensure that the coding standards are used (based on https://github.com/airbnb/javascript), there is a .editorconfig (http://editorconfig.org/) in the repo to help.
  • Ensure that the current tests pass, and if you've added something new, add the tests where relevant.
  • Remember that we follow SemVer. If you are changing the behaviour, or the public api, you may need to update the docs.
  • Send a coherent commit history, making sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.
  • You may also need to rebase to avoid merge conflicts.

Running Tests

First, install the dependencies:

$ npm install

Then run the test command:

$ npm test

If the test suite passes on your local machine you should be good to go.

When you make a pull request, the tests will automatically be run again by Travis CI