Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 722 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (19 loc) · 722 Bytes

Contributing

Feel free to submit issues and/or PRs if you found bugs 🐞 or have some features in mind! The documentation improvements will be super appreciated, if you feel that docs are lacking in some places 📝👩‍🔬

Developing locally (Quick Start)

If you want to work on the library locally:

  1. Fork this repository and clone your version of the repo
  2. Switch to correct node version
nvm use
  1. Install npm dependencies
npm install

When you commit changes, eslint will make sure that there are no linting errors and prettier will format your code based on the repo settings.

When you push changes, jest will run a set of unit tests to make sure that all of them are passing.