docs(scripts): note why run_check scans README in full but restricts CLAUDE.md

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Qgc6RYXWJPr5oW9DHU7zR4
This commit is contained in:
Claude 2026-08-24 21:09:57 +00:00
parent 4e93f8f66e
commit d979128244
No known key found for this signature in database

View file

@ -273,6 +273,10 @@ def run_check(root: Path, derived: dict) -> int:
readme = root / "README.md"
if readme.is_file():
# README is scanned in full (unlike CLAUDE.md below): it carries no
# version-history prose, so every claim-pattern match in it is a live
# headline that must agree with the derived values. If a history
# section is ever added to README, restrict this the same way.
sources.append(("README.md", readme.read_text(encoding="utf-8")))
claude_md = root / "CLAUDE.md"