Skip to content
This repository has been archived by the owner on Sep 13, 2023. It is now read-only.

Latest commit

 

History

History
44 lines (30 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 1.63 KB
Raw

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

  1. Fork and clone the repo
  2. yarn to install dependencies
  3. yarn validate to validate you've got it 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 contributor:add <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.

Help needed

Raise an issue!

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