Contributing

Hi there! I'm 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.

Submitting a pull request

Fork and clone the repository
Configure and install the dependencies: yarn install
Create a new branch: git checkout -b my-branch-name. Make sure to give a good name to the branch. New features shall start with feature/<branch name>. Bug fixes shall start with fix/<branch-name>
Make your change, add tests, and make sure the tests still pass
Push to your fork and submit a pull request
Give yourself a high five, 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 is accepted:

Follow the style guide which is using standard. Any linting errors should be shown when running npm test.
- Some linting errors might be automatically fixed by yarn run lint-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, submit them as separate pull requests.
Write a good commit message.

Work in the Progress pull requests are also welcome to get feedback early on, or if there is something blocking you.