Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1.04 KB

CONTRIBUTING.md

File metadata and controls

27 lines (19 loc) · 1.04 KB
Raw

Contribute

Pull requests are accepted.

Acceptance Criteria

Pull requests will be considered if they pass the following criteria:

  1. Code passes all unit tests.
  2. Code coverage is still above 95% accross the board.
  3. Commit matches suggested format (see Commit Format below).

If all of the above is passed, your request will be considered. Please allow for a few days for follow-up to your request. Any issues with your request will be posted directly to the request itself.

Commit Format

Commits should match the suggested workflow and format.

  1. Change code.
  2. Type git commit -a -m "<type>(<scope>): <subject>"
    1. The standardjs linter will run.
    2. We also use default parameters from validate-commit-msg for validation.
  3. Type git push
    1. Tests will run before the commit is pushed to validate everything still runs as expected.
    2. When ready, open a pull-request.