To contribute to the project, please follow these steps:
- Get approval for the idea by filing an issue and talking with me about the changes.
- Fork the repo
- Make a branch for your change
- Run
npm install
oryarn
- Run
npm t
oryarn test
- Make your changes (Use AirBnb Style Guide)
- Test your changes (we have a githook that disallows anything less than 100% code coverage)
- Run
git add -A
to add your changes (please don't add any changes to thedist
directory). - Run
npm run commit
oryarn commit
(Do not usegit commit
) - follow the prompts to create your git message - Push your changes with
git push
- Create the Pull Request
- Get merged and celebrate 🎉 🎊!