Contributing

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Steps

File an issue and discuss your proposed solution first
Fork and clone the repo
$ npm install to install dependencies
$ npm run validate to validate you've got it working
Create a branch for your PR
$ npm run test -- --watch to 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 validate to make sure things look good.
Commit your changes following our standards (optionally use $ npm run commit to craft a commit message and commit. If you're having trouble committing, try adding --no-verify to your git commit command and ask for help in the pull request :-)
Push your branch to your fork
Make a pull request to master on 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

... and follow the instruction of the interactive prompt.

npm run commit will not execute any tests, prior commiting, however you can opt into it.

In order to execute tests automatically before commit, create a file .opt-in in the root of the project with pre-commit as the content.

Excute the following command in the root of the project to create the above stated file.

$ echo pre-commit > .opt-in