33 lines (21 loc) · 1001 Bytes

Contributing

Thanks for being willing to contribute!

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Project setup

Fork and clone the repo
$ yarn install to install dependencies
$ yarn test to validate you've got it working
Create a branch for your PR

Making changes

All changes should have unit tests
Any relevant documentation should be updated
No linting warnings/errors should be introduced

Committing and Pushing changes

Once you are ready to commit the changes, please use the below commands

git add <files to be comitted>
git commit -m 'A meaningful message

Note: please use present tense in commit messages i.e. Add feature X and not ~~Added feature X~~

Help needed

Please checkout the ROADMAP and raise an issue to discuss any of the items