Feedback, bug reports, and pull requests are welcome. Feel free to ask for help.
- Fork it
- Clone it
- Install dependencies (
npm install
) - Create new branch (Refer to
Naming Your Branch
for branch naming conventions) - Make changes
- If adding features or making fixes, write tests for your changes using Jest.
- Test your project. ensure 100% code coverage (
npm test --coverage
) - Stage and commit (
pre-commit
hook with lint and format your changes. Address any linting errors if necessary) - Push and Create new Pull Request
Name your branch with the following convention: fix/xxx
or feat/xxx
or docs/xxx
where xxx
is a short description of the changes or feature you are attempting to add.
For branches made to address specific issues, add the issue Id to the end of the branch name following a -
ex. fix/xxx-issue-x
We use Jest to write tests
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub