Initial publish v0.1.0: standalone workflow core (corpus + examples + guards)
This commit is contained in:
octopus
@@ -0,0 +1,53 @@
|
||||
# Code Review Dimensions
|
||||
|
||||
> Reference data for the 10 review dimensions. Read on-demand by the Orchestrator
|
||||
> when dispatching reviewers and filling per-dimension prompt values.
|
||||
|
||||
Each reviewer is assigned exactly **one** dimension at **L tier** (1 reviewer
|
||||
per dimension). At S/M tiers the risk-tier table groups dimensions into a
|
||||
single-reviewer sweep (S: all 10) or three grouped sweeps (M: COR+TST+DBT /
|
||||
DGN+SEC+PERF / STY+A11Y+DOC+TRC) — a reviewer covering a group inspects each
|
||||
dimension's checklist items listed below and nothing else (see
|
||||
`review-code/SKILL.md` "Risk Tier Assessment").
|
||||
|
||||
| # | Dimension | Label | Checklist Ref | Code Files to Review | Design Reference Files |
|
||||
|---|-----------|-------|---------------|----------------------|------------------------|
|
||||
| 1 | COR | Correctness, Error Handling & Compatibility | COR 1.1-1.17 | All changed code files | `{slug}/03-design-03-component-design-*`, `{slug}/03-design-04-interface-design` (error paths) |
|
||||
| 2 | DGN | Design Compliance & Dependencies | DGN 2.1-2.15 | All changed code files, package manifests | ALL design files |
|
||||
| 3 | SEC | Security | SEC 3.1-3.10 | Auth, input, data-handling | `{slug}/03-design-06-non-functional-design` (security section) |
|
||||
| 4 | PERF | Performance | PERF 4.1-4.10 | Loops, queries, I/O paths | `{slug}/03-design-06-non-functional-design` (performance section) |
|
||||
| 5 | TST | Test Quality | TST 5.1-5.8 | All test files | `{slug}/03-design-03-component-design-*` (expected behavior) |
|
||||
| 6 | STY | Style & Convention | STY 6.1-6.8 | All changed code files | (none — self-contained against project conventions) |
|
||||
| 7 | DBT | Database & Data | DBT 7.1-7.7 | Migrations, query code | `{slug}/03-design-05-data-design` |
|
||||
| 8 | A11Y | Accessibility & Browser Compatibility | A11Y 8.1-8.13 | UI components, markup | `{slug}/03-design-06-non-functional-design` (a11y section) |
|
||||
| 9 | DOC | Documentation | DOC 9.1-9.6 | All changed code files | `{slug}/03-design-03-component-design-*` (for cross-ref accuracy) |
|
||||
| 10 | TRC | Traceability | TRC 10.1-10.7 | All changed code files, tests | `{slug}/03-design-08-traceability`, work items (DAG task mode: the node `req_refs` + requirement registry rows in `{epic-slug}/dag` + node AC `test_id` declarations) |
|
||||
|
||||
> **DAG task mode**: the legacy `{slug}/03-design-*` Design Reference Files in
|
||||
> the rows above (COR/SEC/PERF/TST/DBT/A11Y/DOC) resolve from the frozen DAG
|
||||
> copy per the DAG-route read map — node spec + cross-session edge contracts
|
||||
> in `{epic-slug}/dag` + node ticket body (same remap as the TRC row above;
|
||||
> see `implement/SKILL.md` § Preconditions "DAG-route read map"d map").
|
||||
|
||||
**Rationale**: Single-dimension assignments prevent context explosion.
|
||||
A reviewer inspecting one dimension examines fewer checklist items and can
|
||||
read code files more deeply within the token budget. The 10 dimensions
|
||||
consolidate the previous 13: COR absorbs error handling (ERR) and
|
||||
compatibility (COR 1.15-1.17), DGN absorbs dependencies (DEP).
|
||||
|
||||
## Design Baseline
|
||||
|
||||
The approved design document at wiki page `{slug}/03-design-index` is the
|
||||
**authoritative baseline** for code correctness. Every reviewer receives the
|
||||
design `index.md` as a mandatory input for orientation.
|
||||
|
||||
Reviewers whose dimension involves design compliance (COR, DGN, SEC, PERF,
|
||||
TST, DBT, A11Y, DOC) additionally receive the relevant design sub-files listed
|
||||
above. Reviewers whose dimension is self-contained (STY) use the design baseline
|
||||
index only. (TRC is NOT self-contained — it reads `{slug}/03-design-08-traceability`
|
||||
and the work-item list to verify REQ references, per its row above; on the
|
||||
DAG route that archived page does not exist — TRC's declared input remaps to
|
||||
the node `req_refs` + requirement registry rows in `{epic-slug}/dag` and the
|
||||
node AC `test_id` declarations, mirroring the DGN remap in
|
||||
`review-code/SKILL.md` § DAG Task Mode. Historical `{slug}/03-design-*`
|
||||
pages stay readable via `_shared/gitea-read-patterns.md`.)
|
||||
@@ -0,0 +1,27 @@
|
||||
# Code Review Output Artifacts
|
||||
|
||||
> Output tree for code review artifacts. Read on-demand for reference.
|
||||
> Output model ([org-internal #1988] Tier 1 migration): Tier 1 local files (raw dimension findings) + Tier 2 wiki pages (task prompts, revision summaries, final reports) + Tier 2 synthesis comment. Status tracking via commit status `pipeline/review-code`.
|
||||
|
||||
```
|
||||
<runs-root>/{slug}/reviews/code/
|
||||
├── round{N}/
|
||||
│ ├── findings-{DIMENSION_CODE}.json # Reviewer dimension findings (Tier 1 local, validated by reviewer-output.schema.json)
|
||||
│ └── task-synthesizer.md # Synthesis prompt (Tier 1 local, passed to Synthesizer via prompt_file)
|
||||
|
||||
Ticket: #{issue_number}
|
||||
└── synthesis comment # Orchestrator synthesis (```json block, Tier 2)
|
||||
|
||||
Wiki: {slug}/reviews/code/
|
||||
├── round{N}/
|
||||
│ ├── task-developer # Phase C dispatch prompt (wiki page)
|
||||
│ └── revision-summary # Developer revision summary (wiki page)
|
||||
└── final/
|
||||
└── report # Final human-readable report (wiki page)
|
||||
|
||||
Commit status: context "pipeline/review-code"
|
||||
```
|
||||
|
||||
**Dimensions (10)**: COR, DGN, SEC, PERF, TST, STY, DBT, A11Y, DOC, TRC
|
||||
|
||||
See `code-review-dimensions.md` for mapping. ERR/DEP/CMP were merged into COR/DGN per the 13→10 consolidation.
|
||||
Reference in New Issue
Block a user