Skip to content
Switch branches/tags
Go to file
Cannot retrieve contributors at this time

How to contribute

I love pull requests. And following this simple guidelines will make your pull request easier to merge.

Submitting pull requests

  1. Create a new branch, please don’t work in master directly.
  2. Add failing tests (if there’re any tests in project) for the change you want to make. Run tests (see below) to see the tests fail.
  3. Hack on.
  4. Run tests 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.

JavaScript code style

See here.

Other notes

  • If you have commit access to repository and want to make big change or not sure about something, make a new branch and open pull request.
  • Don’t commit generated files: compiled from Stylus CSS, minified JavaScript, etc.
  • Don’t change version number and change log.
  • Install EditorConfig plugin for your code editor.
  • Feel free to ask me anything you need.

Building and running tests

Run these commands in the root folder of the repository.

Install dependencies and bootstrap Lerna:

npm run bootstrap

Run tests for all packages:

npm test

Or run a watch mode:

npm run test:watch