When contributing to this repository, please first discuss the change you wish to make via issue with the owners of this repository before making a change.
Please note we have a Contributor Code of Conduct, please follow it in all your interactions with the project.
- Fork and clone the repository
- Make sure the tests pass on your machine:
yarn test, which contains - Create a new branch:
git checkout -b my-branch-name - Make your change, add tests, and make sure the tests still pass.
- Push to your fork and submit a pull request.
- Pat your self 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:
- 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.
Work in Progress pull request are also welcome to get feedback early on, or if there is something blocked you.