diff --git a/AGENTS.md b/AGENTS.md index 0b173a5..f45bc00 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -35,6 +35,10 @@ make demo # python -m contextweaver demo make ci # fmt + lint + type + test ``` +After cloning, run `pre-commit install` once to activate the git hooks. The hooks +run `ruff format` and `ruff check --fix`, plus standard file hygiene checks, +automatically on every `git commit`. + ## Conventions - Python ≥ 3.10, zero runtime dependencies - All public APIs: type hints + docstrings diff --git a/CLAUDE.md b/CLAUDE.md index 92a7e28..4c07c59 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,6 +1,7 @@ # contextweaver — Claude Guide ## Do +- Run `pre-commit install` once after cloning to activate git hooks (ruff format + check, and file hygiene checks, on every commit) - Run `make ci` before submitting any change - Use `make fmt` to auto-format code - Keep each module ≤ 300 lines