Welcome to Kodkod, a suite of agile pre-commit plugins designed to enhance your development workflow. Named after the swift and elusive wildcat, Kodkod embodies precision, efficiency, and adaptability. Our first plugin in this suite focuses on ensuring that your commit messages meet our standards, with more plugins to come.
- Python 3.10 or later
- Git
To use the Kodkod pre-commit plugins, first, ensure you have pre-commit installed. If not, you can install it using pip:
pip install pre-commit
Next, add Kodkod to your project's .pre-commit-config.yaml file:
repos:
- repo: https://github.com/VSX-ViewSonic/kodkod
hooks:
- id: check-commit-message
name: Check for ClickUp ticket ID
entry: check-commit-message
language: python
stages: [commit-msg]
Finally, install the git hook scripts:
pre-commit install