SuperAPI AI Directory

workspace-standards-review

Coding & development

View repository

Updated 10-15 21:08

About this skill

Reviewing a change against the workspace's standards

This skill is guidance, not a complete checklist. Verify the change's live base and head, then read the diff and enough surrounding context to understand the design before judging. A short review with one substantiated blocker beats a list of nits.

For code-facing reviews — lifecycle, concurrency, invariants, disposal, and other implementation semantics — also load the code review checklist.

Sources of truth

  • The workspace's root AGENTS.md: skill authoring, validation, and quality-gate rules.
  • The documentation standard (usually docs/AGENTS.md), with doc-standards for placement, structure, and budget audits.
  • prose-standard: required coverage and editorial judgment.
  • trim-cot-leakage and prune-prompt-pollution: reasoning-transcript and prompt-pollution smells respectively.
  • The Agent Note rules (usually .agents/notes/README.md), with archive-agent-notes for supersession and archival. Treat disagreement with a note as a design discussion, not an automatic veto.
  • The bilingual pairing contract and terminology table (usually docs/i18n/README.md and docs/i18n/terminology.md), with translate-docs for counterpart updates.
  • setup-demon-skills: the scaffold that installs the conventions above. When a workspace lacks one, report the gap rather than inventing a standard.
  • pre-push-checks: which checks cover a given diff, so the review can ask what the change should have carried before it was pushed.

Blocking requirements

  1. New prose receives semantic review. Critically review every added or changed SKILL.md, description, doc, Agent Note, and comment with prose-standard. Automated checks do not establish coverage, accuracy, or placement.
  2. Skills follow the layout and manifest. A new skill has a valid name (hyphen-case) and a trigger-focused description; it is listed in the skill manifest; and its install name is unique across categories. Flag platform-specific metadata, runtime branding, and hard local paths unless justified — rg -n "C:\\|C:/|Users/|Users\\|\.agents|\.codex|OpenAI|Codex|Claude|Cursor|openai\.yaml|agents/openai|must use|must install|requires? .*skill|depends? on .*skill" "skills/<category>/<skill-name>" finds them, and a legitimate match needs its reason stated.
  3. Bilingual pairs update together. A change to either side of a pair updates the counterpart and keeps both switcher lines; the documentation gates are green. A green pairing check does not prove translation quality.
  4. Every non-trivial change carries an Agent Note in the same diff, updated to shipped present-tense state when a proposal is implemented.
  5. Required evidence exists. The author ran the relevant checks for the diff (documentation gates, skill validator, git diff --check); review covers the semantic gaps those cannot detect.

Manual checks

  • Intent and contract: trace both sides of every changed rule or workflow; confirm the change matches the PR description and any Agent Note.
  • Trigger quality: a description's triggers are behavior-based and one per distinct branch, not a keyword pile or workspace identity the body already carries; when Matt's writing pack is installed, writing-for-agents owns the delivery frame those descriptions are written in.
  • One home per fact: no rule restated in a second location without a link to its owner; no reasoning transcript, change narration, or duplicated rationale.
  • Scope and necessity: challenge speculative generality and unrelated edits; each change maps to a current consumer or a recorded decision.
  • Scripts: deterministic helpers handle failures loudly and state non-obvious contracts; generated files are not hand-edited.
  • Test/validation strength: assertions fail on the intended regression rather than restating the implementation.

Reporting findings

State the defect, location, impact, and evidence. Separate blockers from suggestions and omit issues a green check already enforces. When receiving review, verify each claim and fix or rebut it on technical grounds without performative agreement. When the review surfaces dead, duplicated, speculative, or over-built surface, hand those candidates to find-simplifications to turn them into proposed Agent Notes or TODO(tag) markers.