Hello there! 👋 We're thrilled that you're considering contributing to this project. Your help is essential for keeping it great. 🙌
Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.
If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We appreciate all contributions. If you have questions, we'd love to hear them too.
We also welcome PRs. For larger PRs, we advise opening an issue first to discuss it. If you're not sure how to open a PR, check out the links below.
- Fork and clone the repository.
- Configure and install the dependencies:
npm install. - Make sure the tests pass on your machine:
npm test. Note: these tests also apply the linter, so there's no need to lint separately. We've set up a pre-commit hook with Husky, so tests will automatically run before each commit. - Format your code:
npm run format. - Create a new branch:
git checkout -b my-branch-name. - Make your change, add tests, and ensure the tests still pass.
- Push to your fork and submit a pull request.
- Pat yourself on the back 👏 and wait for your pull request to be reviewed and merged.
Here are a few things that will increase the likelihood of your pull request being accepted:
- Write and update tests.
- Keep your changes as focused as possible. If there are multiple changes you'd like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a good commit message.
Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocking you.