Skip to content
This repository has been archived by the owner on Sep 22, 2022. It is now read-only.

Latest commit

 

History

History
47 lines (30 loc) · 1.57 KB

Contributing.md

File metadata and controls

47 lines (30 loc) · 1.57 KB

How to contribute

We 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, take a look at these two labels: help wanted and good first issue.

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 correct settings.
  • Fork the repository and clone your fork.
  • Install dependencies: npm install.

Development workflow

Run linters and tests:

npm test

Or run tests in watch mode:

npm run test:watch

To update 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 or update 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, like minified JavaScript.
  • Don’t change version number and change log.

Need help?

Feel free to ask.