How to contribute

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

Submitting pull requests

Create a new branch, please don’t work in master directly.
Add failing tests for the change you want to make. Run tests (see below) to see the tests fail.
Hack on.
Run tests to see if the tests pass. Repeat steps 2–4 until done.
Update the documentation to reflect any changes.
Push to your fork and submit a pull request.

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.

Yarn is recommended but you can use npm too.

Install dependencies first:

yarn

Then run Babel in watch mode and start example style guide:

yarn run compile:watch & yarn start

Open localhost:6060 in a browser.

(There are other example style guides to test particular features too, run yarn run to see a list.)

Run linters and tests:

yarn test

Or run tests in watch mode:

yarn run test:watch