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.
Use GitHub interface for simple documentation changes, otherwise follow the steps below.
- Fork the repository and clone your fork.
- Install dependencies:
yarn
.
Run linters and tests:
yarn lint
yarn test
Don’t forget to add tests and update documentation for your changes.
Please commit the updated yarn lock file (yarn.lock
) if you add or update dependencies.
- Remember to compile and commit the compiled JavaScript in
lib/
. - 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 code, so don’t worry much about code formatting.
- Don’t change version number and changelog.
If you want to contribute but have any questions, concerns or doubts, feel free to ping maintainers. Ideally create a pull request with WIP
(Work in progress) in its title and ask questions in the pull request description.