Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub
- File an issue and discuss your proposed solution first
- Fork and clone the repo
$ npm installto install dependencies$ npm run validateto validate you've got it working- Create a branch for your PR
$ npm run test -- --watchto watch the file system as you make changes to things- Make your changes. Make sure to add yourself to the
.all-contributorsrc! More info - Run
npm run validateto make sure things look good. - Commit your changes following our standards (optionally use
$ npm run committo craft a commit message and commit. If you're having trouble committing, try adding--no-verifyto yourgit commitcommand and ask for help in the pull request :-) - Push your branch to your fork
- Make a pull request to
masteron this repository - Get merged
- Celebrate 🎉
As stated earlier, please follow this convention for your commit messages.
Once you are ready to commit the changes, please use the below commands
git add <files to be comitted>$ npm run commit
... and follow the instruction of the interactive prompt.