Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.07 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.07 KB

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. See GitHub for more details.

Pre-Commit

Pre-commit is used to ensure that all files have consistent formatting and to avoid committing secrets. Please install and integrate the tool before pushing changes to GitHub.

  1. Install pre-commit in venv 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

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