We love pull requests. And following these 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.
- If it’s your first pull request, watch this amazing course by Kent C. Dodds.
- Fork the repository and clone your fork.
- Install dependencies:
npm install.
Start from the develop branch.
To build you changes run:
npm run buildRun linters and tests:
npm testOr run tests in watch mode:
npm test --watchDon’t forget to add tests and update documentation for your changes. Documentation can be archived by using JSDoc.
Please update the npm lock file (package-lock.json) if you add or update dependencies.
For commit messages use Conventional Commits, like so: feat(scope): topic
For the most common pull requests such as bug fixes, feature additions, documentation changes, etc., target the develop branch.
For major changes that markedly transform the existing API or significantly alter the behavior of some functionality ensure that the corresponding commits contain appropriate Conventional Commits breaking change notations and as the pull request target select the beta branch.
- If you have commit access to the repository and want to make a big change or are unsure about something, make a new branch and open a pull request.
- We’re using Prettier to format code, so don’t worry much about code formatting.
- Don’t commit generated files, like minified JavaScript.
- Don’t change the version number or 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.