Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

34 lines (24 loc) · 1.12 KB
Raw

How to contribute

Contributions are welcome to this repo, but we do have a few guidelines for contributors.

Open an issue and pull request for changes

All submissions, including those from project members, are required to go through review. We use GitHub Pull Requests for this workflow, which should be linked with an issue for tracking purposes. A GitHub action will be run against your PR to ensure code standards have been applied.

pre-commit is used to ensure that all files have consistent formatting and to avoid committing secrets.

  1. Install pre-commit in a virtual python environment or globally: see instructions

  2. Fork and clone this repo

  3. Install pre-commit hook to git

    E.g.

    pip install -r requirements-dev.txt
pre-commit install --hook-type commit-msg --hook-type pre-commit

  4. Create a new branch for changes

  5. Commit and push changes for PR

    The hook will ensure that pre-commit will be run against all staged changes during git commit.