Skip to content

docs(readme): explain how to use the shipped checks without the templates (#2412) - #2423

Open
braboj wants to merge 2 commits into
mainfrom
docs/readme-hooks-only
Open

braboj wants to merge 2 commits into
mainfrom
docs/readme-hooks-only

Conversation

@braboj

@braboj braboj commented Oct 31, 2026

Copy link
Copy Markdown
Collaborator

A project can take only the shipped checks, the hooks-only model of chapter 7.3, but nothing told it how to start. The README now does.

File Change
README.md New section "Use the checks only": config snippet, hook table, local and CI use, not applicable
tools/sync_docs.py Generates the hook table from .pre-commit-hooks.yaml, without deprecated hooks; refuses an empty table
CHANGELOG.md An Added entry

Checks run: smoke, sync_docs --check, pyflakes, markdownlint.

Closes #2412

🤖 Generated with Claude Code

https://claude.ai/code/session_01DpT5xSVK2FLNdArtRtNjLH

braboj and others added 2 commits October 31, 2026 14:17
…ates (#2412)

The hook table is generated from .pre-commit-hooks.yaml, leaving out
deprecated hooks, so it cannot drift from the hooks upstream ships.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DpT5xSVK2FLNdArtRtNjLH
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Explain in the README how to use the shipped checks without the templates

1 participant