CONTRIBUTING.md

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

You're going to need git to get the project, and node and yarn to install dependencies and run scripts.

1. Fork and clone the repo
2. Run yarn to install dependencies
3. Run yarn run validate to validate you've got everything working
4. Create a branch for your PR

Add yourself as a contributor

This project follows the all contributors specification. To add yourself to the table of contributors on the README.md, please use the automated script as part of your PR:

yarn run add-contributor <YOUR_GITHUB_USERNAME>

Follow the prompt. If you've already added yourself to the list and are making a new type of contribution, you can run it again and select the added contribution type.

Committing and Pushing changes

This project uses semantic-release to do automatic releases and generate a changelog based on the commit history. So we follow a convention for commit messages. Please follow this convention for your commit messages.

You can use commitizen to help you to follow the convention

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

1. Run git add <files to be comitted> to stage changed files
2. Run yarn run commit to start commitzen to commit those files

... and follow the instruction of the interactive prompt.

opt into git hooks

There are git hooks set up with this project that are automatically installed when you install dependencies. They're really handy, but are turned off by default (so as to not hinder new contributors). You can opt into these by creating a file called .opt-in at the root of the project and putting this inside:

commitmsg
precommit

Help needed

Please checkout the issues! Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks!