Thanks for being willing to contribute!
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub
(node
v6 is required to run tests.)
- Fork and clone the repo
$ npm install
to install dependencies$ npm start validate
to validate you've got it working- Create a branch for your PR
This project uses nps
and you can run npm start
to see what scripts are available.
This project follows the all contributors specification. To add yourself to the table of contributors on the README.md, please use the automated script as part of your PR:
npm start contributors.add
Follow the prompt. If you've already added yourself to the list and are making a new type of contribution, you can run it again and select the added contribution type.
This project uses semantic-release
to do automatic releases and generate a changelog based on the
commit history. So we follow a convention for commit messages. Please follow this convention for your
commit messages. If you don't, it's not a huge deal because we can change your commit message when we merge anyway.
Please make sure to run the tests before you commit your changes. You can run npm start test.update
which will
update any snapshots that need updating. Make sure to include those changes in your commit.
There are git hooks set up with this project that are automatically installed when you install dependencies. They're
really handy, but are turned off by default (so as to not hinder new contributors). You can opt into these by creating
a file called .opt-in
at the root of the project and putting this inside:
pre-commit
Please checkout the ROADMAP.md and raise an issue to discuss any of the items in the want to do or might do list.
Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks!