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. 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'd love all and any contributions. If you have questions, too, we'd love to hear them.
We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.
- Fork and clone the repository.
- Configure and install the dependencies:
yarn install. - Create a new branch:
git checkout -b my-branch-name. - Work on your issue/feature
- Before committing the changes run tests using
yarn test - Follow Conventional Commits for writing commit messages
- Push to your fork and submit a pull request in
mainbranch - Pat your self on the back and wait for your pull request to be approved and merged.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Keep your changes 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.
- Follow Conventional commits.
Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you. (just mark them as draft)