Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.38 KB
Raw

Contributor's Guide

Feedback, bug reports, and pull requests are welcome. Feel free to ask for help.

Guide:

  1. Fork it
  2. Clone it
  3. Install dependencies (npm install)
  4. Create new branch (Refer to Naming Your Branch for branch naming conventions)
  5. Make changes
  6. If adding features or making fixes, write tests for your changes using Jest.
  7. Test your project. ensure 100% code coverage (npm test --coverage)
  8. Stage and commit (pre-commit hook with lint and format your changes. Address any linting errors if necessary)
  9. Push and Create new Pull Request

Naming Your Branch

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

Testing

We use Jest to write tests

First Time Contributors

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