skills-vault/skills/review-context-builder/SKILL.md

3.3 KiB

name description
review-context-builder Use when Codex needs to build a file-first review, audit, planning, synthesis, release, handoff, CCRA, article, video, Skill, model-card, PR, or agent-invocation context package from configured local files, reports, diffs, validation outputs, prior decisions, metadata, include/exclude patterns, and source roots.

Review Context Builder

Purpose

Build a deterministic context index and file manifest before reviewer or Agent invocation. Use the bundled script to identify the files a reviewer should read, categorize references, pass metadata through, and record missing or excluded sources.

This Skill creates navigation context only. It must not summarize source evidence in a way that replaces file reading, make findings, create bundles, or decide readiness.

Command

conda run -n skills-vault python .\scripts\review_context_builder.py `
  --project-root C:\path\project `
  --review-id round-05-local-pass `
  --source-root README.md `
  --source-root reports `
  --include-pattern "**/*.md" `
  --exclude-pattern "archive/**" `
  --metadata C:\path\metadata.json `
  --output-dir C:\path\helper-outputs

When installed under C:\Users\wangq\.agents\skills\review-context-builder, run from that Skill directory or use the installed script path.

Inputs

  • --project-root: root used for path normalization and source-root containment.
  • --review-id: stable ID for the review or handoff context.
  • --context-profile: optional label, default generic.
  • --source-root: repeatable file or directory, relative to project_root or absolute under it.
  • --include-pattern: repeatable glob, default **/*.
  • --exclude-pattern: repeatable glob for files to record as excluded.
  • --metadata: optional JSON/YAML object; passed through without hard-coded CCRA fields.
  • --max-file-bytes: files larger than this are excluded and recorded.

Outputs

The script writes under output_dir:

review-context.md
review-file-manifest.json

Outputs include:

  • review ID and context profile
  • source roots and missing source roots
  • files included and excluded
  • important report references
  • test or validation output references
  • diff or changed-file references
  • prior decision references
  • known non-goals and open questions from metadata
  • original metadata passthrough
  • machine-readable summary

Rules

  • Normalize included paths as project-relative POSIX paths.
  • Keep output ordering stable.
  • Treat missing source roots as blockers while still writing both output files.
  • Exclude large files instead of embedding content.
  • Do not read or quote source file bodies for context prose.
  • Do not inject project-specific fields unless they came from metadata.

Safety

  • Read only configured source roots and optional metadata file.
  • Write only review-context.md and review-file-manifest.json under output_dir.
  • Do not edit project files.
  • Do not create review bundles.
  • Do not decide review acceptance, round closure, lifecycle status, release readiness, or task approval.

Validation

After changing builder behavior, run:

conda run -n skills-vault python -B -m unittest discover -s skills/review-context-builder/tests -v
conda run -n skills-vault python -B C:\Users\wangq\.codex\skills\.system\skill-creator\scripts\quick_validate.py skills/review-context-builder