Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.
- 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
- Pat your self on the back 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.
Work in Progress pull request are also welcome to get feedback early on, or if there is something blocked you.