Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 858 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (15 loc) · 858 Bytes

Contributing

To contribute code changes or update the documentation, please follow these steps:

  1. Fork the upstream repository and clone the fork locally.
  2. Install pre-commit
  3. Navigate to the cloned repository's directory and install the hooks by running:
pre-commit install \
   && pre-commit install --hook-type commit-msg \
   && pre-commit install-hooks
  1. Make whatever changes and additions you wish and commit these - please try to keep your commit history clean.
  2. Create a pull request to the main repository with an explanation of your changes.

Note:

  • if you add new code or modify existing code - 100% test coverage is mandatory and tests should be well written.
  • we follow conventional commits and this is enforced using a pre-commit hook.