From 930d0e53b5e654723b7dbea1da0d0d2a6e7ebff4 Mon Sep 17 00:00:00 2001 From: shokollm <270575765+shokollm@users.noreply.github.com> Date: Tue, 7 Apr 2026 04:35:14 +0000 Subject: [PATCH] docs: add pre-commit hooks section to CONTRIBUTING.md (#117) --- CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7af9dcb..0209792 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,38 @@ - Test changes before submitting - See [VERSIONING.md](VERSIONING.md) for backport compatibility rules +## Pre-commit Hooks + +This repository uses [pre-commit](https://pre-commit.com/) for linting and commit message enforcement. + +### Setup + +```bash +pip install pre-commit +pre-commit install +``` + +### Hooks + +- **shellcheck** — Lints bash scripts +- **ruff** — Lints and formats Python +- **commitizen** — Enforces [Conventional Commits](https://www.conventionalcommits.org/) format + +### Commit Message Format + +Use Conventional Commits format: + +``` +type(scope): message + +# Examples +fix(session): handle missing session gracefully +feat(pm): add queue daemon for task delegation +docs: update contributing guide +``` + +Types: `fix`, `feat`, `docs`, `refactor`, `chore`, `test` + ## Branches ### Primary Branches