Contributing.md

How to contribute

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

If you want to contribute but don’t know what to do (we need you!): we have two labels in issue for you: pull request welcome and easy task. Our docs and site are far from perfect too and would like to get some love.

Prerequisites

• If it’s your first pull request, watch this amazing course by Kent C. Dodds.
• Install EditorConfig plugin for your code editor to make sure it uses the correct indentation.
• Fork the repository and clone your fork.
• Install dependencies: npm install.
• Read the developer guide.

Development workflow

Run Babel in watch mode and start example style guide:

npm run compile:watch & npm start

Open localhost:6060 in a browser.

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

Run linters and tests:

npm test

Or run tests in watch mode:

npm run test:watch

To update the Jest snapshots:

npm run test:jest -- -u

Don’t forget to add tests and update documentation for your changes.

Please update npm lock file (package-lock.json) if you add new dependencies.

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.
• We’re using Prettier to format JavaScript, so don’t worry much about code formatting.
• Don’t commit generated files: compiled from Stylus CSS, minified JavaScript, etc.
• Don’t change version number and change log.

Need help?

• Join our Gitter chat and ask everything you need.