Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.09 KB
Raw

Contributing

Thanks for thinking of contributing 😀

Will this be your first Pull Request?

You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Project Set Up

  1. Fork & Clone repo
  2. $ yarn install to install your dependencies
  3. Create a branch for your work
  4. Open a PR

Making Changes

  • Any changes that require the documentation to be updated must have it done

Add yourself as a contributor

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

yarn 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. If you need to edit the .all-contributorsrc file by hand that's fine too, just run yarn contributor:gen to regenerate the table