mcpField
P
plan-audit

plan-audit

github.com/xiaolaiTesting & quality87869 installsUpdated today
Repository

About plan-audit

A code-review skill that checks completed work against a plan’s work items, acceptance criteria, and required tests. It reports implementation gaps, logic issues, and coverage with file and line references.

Key features

  1. 01Extract plan criteria into a checklist
  2. 02Map code and commits to work items
  3. 03Check behavior against acceptance criteria
  4. 04Review logic, edge cases, and test coverage
  5. 05Report findings with file and line references

Use cases

  1. 01Audit a completed implementation against its plan
  2. 02Find unimplemented acceptance criteria
  3. 03Identify missing or broken tests
  4. 04Document plan-quality gaps and risks

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/xiaolai/vmark --skill plan-audit

After installing, type/plan-auditin Claude Code to confirm it loaded.

Details

From the project README

Plan Audit

Overview

Audits completed work against a plan (WIs + acceptance + tests) and reports gaps, logic errors, and missing coverage with file/line references.

Workflow (Audit)

  1. Locate the plan

    • Prefer dev-docs/plans/<plan>.md.
    • If unclear, ask for the plan path or the WI list.
  2. Extract audit checklist

    • For each WI, list:
      • Goal
      • Acceptance criteria
      • Tests required
      • Touched areas (files/symbols)
  3. Map implementation to WIs

    • Use git log, git show --stat, rg, and file inspection.
    • Record which files/commits satisfy each WI.
  4. Gap & correctness analysis

    • Check each acceptance item vs actual behavior.
    • Find logic errors, edge-case failures, and incomplete flows.
    • Validate test coverage against the “Tests (first)” section.
    • If the plan references specs, verify implementation matches those specs.
    • If the plan is missing acceptance/tests, record it as a plan-quality gap.
  5. Report findings

    • Order by severity: Critical → High → Medium → Low.
    • Each finding must include:
      • WI reference
      • File path + line
      • Why it violates the plan
      • Expected behavior per plan

Output Format (required)

  • Findings (ordered by severity)
    • File:line and WI reference
    • Impact and suggested fix
  • Plan Gaps Summary
    • WI‑### → missing/partial acceptance items
  • Test Coverage Gaps
    • Missing tests, broken tests, or “test not written”
  • Notes / Risks
    • Any assumptions or unverified areas
  • Evidence
    • Cite concrete evidence for each finding (files/lines/commit IDs).

Audit Rules

  • Do not run tests here unless the user explicitly asks; this is an inspection pass.
  • Be strict about spec drift: if behavior diverges from plan text, flag it.
  • If you cannot locate the plan, stop and ask for it.

Comments

Markdown supported