## Contributing [fork]: /fork [pr]: /compare [style]: https://prettier.io [code-of-conduct]: CODE_OF_CONDUCT.md Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great. Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms. ## Submitting a pull request 1. [Fork][fork] and clone the repository 2. Configure and install the dependencies: `yarn install` 3. Make sure the tests pass on your machine: `yarn test` 4. Create a new branch: `git checkout -b my-branch-name` 5. Make your change, add tests, and make sure the tests still pass 6. A pre-commit hook will make sure that your code is properly formatted, but you can also manually check for linting or formatting errors by running `yarn style` 7. Push to your fork and [submit a pull request][pr] 8. Pat yourself on the back and wait for your pull request to be reviewed and merged. Here are a few things you can do that will increase the likelihood of your pull request being accepted: - Follow the [style guide][style] which is using Prettier. Any linting errors should be shown when running `npm lint:check`. Linting or formatting errors can be automatically fixed by running `yarn style:fix`. - Write and update tests. - Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). Work in Progress pull request are also welcome to get feedback early on, or if there is something blocked you. ## Commit Message Format Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**: ``` ():