Check maintainer documentation locally before automated CI checks run. Find missing metadata, outdated review dates, nonexistent paths in the architecture manifest, and completed plans that still contain unfinished tasks, with guidance for correcting common failures.
中文简介正在准备中。当前显示英语简介。
Validate maintainer docs structure, standards freshness, manifest paths, and plan state. Run this after modifying any file under .agents/docs/standards/, .agents/docs/plans/, .agents/docs/architecture/, or AGENTS.md — it catches stale metadata, broken manifest paths, and plan state drift before CI does.
安装前可以查看交给 AI 代理的指令内容。
Run deterministic checks for maintainer docs that mirror what CI enforces via .github/workflows/legibility.yml. Catching these locally saves a round-trip to CI.
.agents/docs/standards/*.md must have frontmatter with owner, last_reviewed (ISO date), and source_of_truth. Files reviewed more than 60 days ago produce a warning..agents/docs/architecture/manifest.yaml under expected_paths: must exist in the repo..agents/docs/plans/**/*.md must have a status frontmatter field (active, completed, or cancelled). Completed plans must not contain unchecked - [ ] checkboxes (outside fenced code blocks).uv run python scripts/check_legibility.py
Options:
--freshness-days N — change the staleness threshold (default: 60)--strict-freshness — promote stale warnings to failures--repo-root PATH — override repo root (default: cwd)| Failure | Fix |
|---|---|
missing frontmatter key 'X' | Add the missing key to the YAML frontmatter block at the top of the file |
last_reviewed must be ISO date | Use YYYY-MM-DD format |
last_reviewed ... is stale | Update last_reviewed to today's date after reviewing the content |
expected path missing: X | Either create the file or remove the stale entry from manifest.yaml |
status must be one of [...] | Add status: active (or completed/cancelled) to plan frontmatter |
completed plan still contains unchecked TODO | Check off remaining items or change status back to active |
Re-run the check to confirm all issues are resolved before committing:
uv run python scripts/check_legibility.py && echo "All clear"
还没有评价。欢迎分享你的使用感受。
无需登录即可发表。欢迎分享使用感受、提问，或说明在哪些环境下无法运行。
还没有评论。来写第一条吧。
Test real Codex CLI sessions through claude-tap, including resumed conversations, multiple tool calls, and image input. Check captured API activity and viewer behavior, then collect screenshots as evidence for a pull request.
中文简介正在准备中。当前显示英语简介。
Create demo GIFs and MP4 videos from real terminal test runs recorded with tmux and asciinema. Capture HTML viewer screenshots through Playwright, with guidance for selecting visible controls and scrolling the correct page containers.
中文简介正在准备中。当前显示英语简介。
Run pytest tests for claude-tap after core changes to check the workflow from end to end. Review results for proxy processing, trace storage, cleanup, and viewers, with guidance on where to investigate failures.
中文简介正在准备中。当前显示英语简介。
Test JavaScript embedded in HTML with two complementary layers: Python unit tests for algorithms and Playwright browser tests for page behavior. Check calculations, button states, keyboard input, and navigation using prepared test data.
中文简介正在准备中。当前显示英语简介。
Record Playwright browser test actions as .webm videos for pull request reviews, bug fix comparisons, and regression evidence. Combine readable pauses, assertions, and terminal logs to show interface behavior alongside automated checks.
中文简介正在准备中。当前显示英语简介。
Check whether a pull request is ready to merge by combining local lint, formatting, and tests with GitHub Actions status and PR description requirements. Returns a readiness verdict with specific reasons for any failed checks.
中文简介正在准备中。当前显示英语简介。