Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 899 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 899 Bytes
Raw

Contributing

Thank you for wanting to contribute to this library.

Project setup

  1. Fork and clone the repo.
  2. Run yarn install to install dependencies.

Adding yourself as a contributor

This project follows the all contributors specification. To add yourself as a contibutor use the all-contributors cli, which is aliased as a package.json script:

yarn contributors:add <github username> <contribution>

So for example, if you added code and updated the docs you will do:

yarn contributors:add <your username> code,doc

For further options see the all-contributors cli docs.

Submit a PR

When you are ready and have finished your modifications submit a PR. Make sure to link to any relevant issue by using the issue number in the description (e.g. #1).