Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 776 Bytes

DEVELOPMENT.md

File metadata and controls

18 lines (14 loc) · 776 Bytes

Developer Guide

Using pre-commit for git hooks

This repository uses the Python pre-commit library to manage git hook run as part of the commit process. Use the following steps from the project root to install a virtual environment with pre-commmit set up, and then use precommit to install git hooks it to your local repository:

python3 -m venv .venv           # Create a Python virtual env
source ./.venv/bin/activate     # Activate the virtual env for bash by source.
pip install -r requirements.txt # Install latest requirements including pre-commit
pre-commit install              # Use pre-commit to install git hooks into the working repository.

pre-commit is configured with .pre-commit-config.yaml which contains some additional documentation.