Hi there! I'm thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
- Fork and clone the repository
- Configure and install the dependencies:
npm install - Make sure the tests pass on your machine:
npm test, note: these tests also apply the linter, so no need to lint seperately - Create a new branch:
git checkout -b my-branch-name - Make your change, add tests, and make sure the tests still pass
- Push to your fork and submit a pull request
- Give yourself a high five, and wait for your pull request to be reviewed and merged.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Follow the style guide which is using standard. Any linting errors should be shown when running
npm test - Write and update tests.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a good commit message.
- This repository uses release-drafter to create release drafts from PR titles so write a short and descriptive PR title, usually the same as the commit title.
Work in Progress pull request are also welcome to get feedback early on, or if there is something blocked you.