-
Select the type from the trigger.
- Milestone completion or maintainer-initiated retrospective โ
business.
- Non-trivial code change โ
code.
- Change touching capabilities / IPC / syscalls / memory / scheduler / boot / crypto /
unsafe / sensitive deps (per security-review.md) โ security.
- Performance concern or hypothesis โ
performance-optimization.
-
Open the type's master plan and read it in full. Each master plan is self-contained and describes its agent roles, procedure, merge step, acceptance criteria, and output template.
-
Read the previous review of the same type on the same scope, if any. Reviews build on each other; orphan reviews drift.
-
Execute the roles described in the master plan. Multi-agent setups can run roles in parallel; single-agent sessions run them sequentially. Either way, each role produces one section of the final artifact.
-
Merge per the master plan's merge step.
-
Write the artifact at docs/analysis/reviews/<type>-reviews/YYYY-MM-DD-<context>.md.
<context> is a short kebab-case slug: milestone id for business, PR or commit id for code / security, concern slug for performance.
- Use the master plan's output template. Do not reshape sections.
-
Update the type's index in docs/analysis/reviews/<type>-reviews/README.md with a new row for this review.
-
Type-specific side-effects:
- business โ update
docs/roadmap/current.md with the new active phase / milestone / task / next-review-trigger per the master plan's Pathfinder role.
- code โ the corresponding commit should gain a reference to this review (convention emerging; once stable, a
Code-Review: trailer).
- security โ the corresponding commit gets a
Security-Review: trailer per commit-style.md; any unsafe changes in scope are cross-referenced with their audit-log entries.
- performance-optimization โ if the verdict is Merge, the merge commit references this artifact.
-
Commit per commit-style.md:
- Scope:
roadmap for business reviews (they touch current.md and the roadmap's forward motion); analysis for code / security / performance-optimization reviews (their artifact lives in docs/analysis/reviews/<type>-reviews/).
- Message:
docs(<scope>): <type>-review <slug> โ e.g. docs(roadmap): business-review A2-completion, docs(analysis): code-review PR-42, docs(analysis): security-review cap-table-revoke, docs(analysis): performance-review ipc-hot-path.
- Body: one-paragraph summary of the verdict / adjustments.
- Trailer:
Refs: ADR-0013 and any ADRs the review cites.