mirror of
https://github.com/jparkerweb/plan2code.git
synced 2026-11-16 20:45:33 -08:00
Offer a final review in Finalize
AI Assisted
This commit is contained in:
1 parent
8e1af1b15d
commit
d6be7f9240
12 files changed
+62
-22
No files matched your search
@@ -8,7 +8,7 @@ QA engineer and technical lead performing rigorous final validation. Verify spec
|
||||
|
||||
## Interface
|
||||
|
||||
The FIRST thing you do, before anything else in this file — before the Required Context check, before Step 1: ask **web console** (browser page, suggested) or **terminal**? Console → run `node "<D>/console.mjs" open --workflow finalize` before reading (<D>: references/web-console/ beside this SKILL.md, or the dir in ~/.plan2code/console/console-dir; `--spec specs/<feature-name>` if known, else post `specDir` later), then read <D>/console.md and <D>/notes/finalize.md; the audit options, the doc-update approval and every cleanup confirmation go through it. Switchable anytime. `--web` or `Use the web console for this session.` in the argument answers it; drop the flag. Dashboard-launched? Resume its open session (console-launches.md), then the Required Context check.
|
||||
The FIRST thing you do, before anything else in this file — before the Required Context check, before Step 1: ask **web console** (browser page, suggested) or **terminal**? Console → run `node "<D>/console.mjs" open --workflow finalize` before reading (<D>: references/web-console/ beside this SKILL.md, or the dir in ~/.plan2code/console/console-dir; `--spec specs/<feature-name>` if known, else post `specDir` later), then read <D>/console.md and <D>/notes/finalize.md; the audit options, the final review, the doc-update approval and every cleanup confirmation go through it. Switchable anytime. `--web` or `Use the web console for this session.` in the argument answers it; drop the flag. Dashboard-launched? Resume its open session (console-launches.md), then the Required Context check.
|
||||
|
||||
## Scripts
|
||||
|
||||
@@ -19,6 +19,7 @@ The FIRST thing you do, before anything else in this file — before the Require
|
||||
- `node "<S>/specs.mjs" metrics <spec> --step finalize --set ...`: Step 7's METRICS_JSON line.
|
||||
- `node "<S>/feedback-payload.mjs"`: Step 6.5 (see its reference).
|
||||
- `node "<S>/commit-msg.mjs" --subject "<subject>"`: the commit command.
|
||||
- `node "<S>/review-scope.mjs"`: the branch's changed files, for Step 2.5's scope.
|
||||
|
||||
## Rules
|
||||
|
||||
@@ -26,10 +27,11 @@ The FIRST thing you do, before anything else in this file — before the Require
|
||||
- Complete steps IN ORDER
|
||||
- STOP and ask user before proceeding when:
|
||||
- Incomplete tasks found (Step 1)
|
||||
- The final review is offered, and its fixes are picked (Step 2.5)
|
||||
- Documentation updates proposed (Step 4)
|
||||
- No documentation changes without explicit user approval
|
||||
- Archive specs to `specs--completed/<feature-name>/` (preserve folder name exactly)
|
||||
- Validation and cleanup only - no implementation code
|
||||
- Validation and cleanup only - no implementation code, except the Step 2.5 review fixes the user picks
|
||||
- If file operations unavailable, output contents in code blocks with intended path as header
|
||||
|
||||
### Required Context
|
||||
@@ -134,6 +136,27 @@ INCOMPLETE TASKS DETECTED
|
||||
|
||||
---
|
||||
|
||||
### STEP 2.5: Final Review (Offered)
|
||||
|
||||
`🧹 [FINALIZATION STEP 2.5: Final Review]`
|
||||
|
||||
**Objective:** One last independent look at the whole feature before it is summarized and archived.
|
||||
|
||||
Always offer it, whatever Step 2 found and however Finalize was started (by hand, from a finished build, or by the Implementation Loop): "Run a final review of the whole feature before the summary? (yes / no)", with its size (files, ~lines). Recommend yes; the person may skip. Skipped → record `skipped (your choice)` and go to Step 3.
|
||||
|
||||
**Scope (decided, never asked):** Focused, the feature's change set: every file the phases' completion summaries and `Files` lists name, plus the tests and docs changed for it. Add `review-scope.mjs`'s files only where they belong to this feature (a branch carrying other work stays out). `overview.md` and the phase files give spec compliance; they do not widen scope.
|
||||
|
||||
On yes, read `references/review.md` and run Review Mode with these overrides:
|
||||
- The scope above; no scope question.
|
||||
- The helper rule applies: a fresh helper runs the analysis when available, you verify every finding, and the report carries its Reviewed by line.
|
||||
- No commit instructions and no next-step routing; Finalize carries both.
|
||||
|
||||
Then the fix choice (`H` / `A` / `S 1,3`, or none) and Review Mode's Post-Fix Flow for the picked findings, ending on its "Reply **approved**" gate. Zero findings: say so with the dimension coverage and go on.
|
||||
|
||||
Record one outcome for Step 3: `N found, M fixed, K open` or `skipped (your choice)`. Every open finding goes in Step 3's Known Limitations with its severity and file. An open Critical: say so plainly and offer going back to `/plan2code-3-implement` before archiving.
|
||||
|
||||
---
|
||||
|
||||
### STEP 3: Implementation Summary
|
||||
|
||||
`🧹 [FINALIZATION STEP 3: Implementation Summary]`
|
||||
@@ -169,6 +192,7 @@ INCOMPLETE TASKS DETECTED
|
||||
[List or "None"]
|
||||
|
||||
Full suite: [passed / failed (N) / skipped (your choice) / not planned]
|
||||
Final review: [N found, M fixed, K open / skipped (your choice)]
|
||||
```
|
||||
|
||||
Add this summary to `overview.md` under `## Completion Summary`.
|
||||
@@ -287,6 +311,7 @@ Paste the `comment` from `specs.mjs metrics <spec's current path: specs--complet
|
||||
### Finalization Steps Completed
|
||||
- [x] Step 1: Task Completion Audit
|
||||
- [x] Step 2: Implementation Verification
|
||||
- [x] Step 2.5: Final Review (Offered)
|
||||
- [x] Step 3: Implementation Summary
|
||||
- [x] Step 4: Documentation Review
|
||||
- [x] Step 5: User Feedback (Optional)
|
||||
@@ -296,6 +321,7 @@ Paste the `comment` from `specs.mjs metrics <spec's current path: specs--complet
|
||||
|
||||
### Files Created/Modified During Finalization
|
||||
- `specs/<feature-name>/overview.md` - Added completion summary
|
||||
- [each file a Step 2.5 fix changed, if any]
|
||||
- `README.md` - [if updated]
|
||||
- `CHANGELOG.md` - [if updated]
|
||||
|
||||
@@ -348,7 +374,7 @@ If you discovered undocumented commands, dependency quirks, gotchas (>5min cost)
|
||||
|
||||
(Step 7 already delivered the completion summary — don't repeat it.)
|
||||
|
||||
Suggested commit (only if README, CHANGELOG, or other tracked docs were updated): the `command` from `commit-msg.mjs --subject "chore: finalize and archive <feature-name>"`. When the console finish prints it, the finish also carries `"commit": true`, so the finished screen offers **Commit it now**.
|
||||
Suggested commit (only if Step 2.5 fixes landed or README, CHANGELOG, or other tracked docs were updated): the `command` from `commit-msg.mjs --subject "chore: finalize and archive <feature-name>"`. When the console finish prints it, the finish also carries `"commit": true`, so the finished screen offers **Commit it now**.
|
||||
|
||||
Returning context: Feature complete. Specs archived to `specs--completed/<feature-name>/`.
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Helper Strength
|
||||
> Shared by the skills that start helpers (subagents): Init, Init Update, Pathfinder, Plan, Revise Plan, Document, Quick Task, Implement, Implement + Review, Review, X-ray and Diagnose. Read it when you first start a helper in a session. Never invoked as a skill.
|
||||
> Shared by the skills that start helpers (subagents): Init, Init Update, Pathfinder, Plan, Revise Plan, Document, Quick Task, Implement, Implement + Review, Review, Finalize, X-ray and Diagnose. Read it when you first start a helper in a session. Never invoked as a skill.
|
||||
|
||||
## The words
|
||||
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
# The Review, Mid-Session
|
||||
|
||||
The console points here on `__review`, or on a `review` card answered with a verdict. Part of the build contract (`building.md`). The same focused review runs from three doors:
|
||||
The console points here on `__review`, or on a `review` card answered with a verdict. Part of the build contract (`building.md`). The same focused review runs from four doors:
|
||||
|
||||
- **`implement`:** the `review` verdict on the sign-off card, before anything is approved. A note sent with it is focus for the review. Settle the card in the post that goes back to work: `{"settle":true,"headline":{"stage":"Reviewing Phase 3","cleared":0,"total":0},"run":{"event":"review","id":"review"},"agent":{"status":"working","activity":"Reviewing the 7 files this phase changed","quietMinutes":15}}`
|
||||
- **`quick-task`:** the **Review it now** button on the finished screen (`finish.review`), arriving as `__review`. Take it up with the same post minus `settle`, plus `"finish":null`.
|
||||
- **`implement-review`:** Stage 2 (`notes/implement.md`).
|
||||
- **`finalize`:** a yes on Step 2.5's "Run a final review" card (`notes/finalize.md`). Settle the card in the post that takes the review up, as for `implement`, with `"stage":"Final review"`. Scope is the whole feature's change set (Step 2.5), not one phase.
|
||||
|
||||
Either way the post that takes the review up carries `"run":{"event":"review","id":"review"}`: the review runs inside this session, so no launch scores it. Never also resume under `--workflow review`, or it counts twice.
|
||||
|
||||
@@ -19,7 +20,7 @@ A quick-task finish carries `review` and `dashboard:true` and waits for whicheve
|
||||
|
||||
**Read `references/review.md`** and run Review Mode with these overrides:
|
||||
|
||||
- Scope is Focused and decided: the exact change set of this session (files created or modified by the phase or the quick task, plus the tests and docs changed for it). Do not ask about scope. `overview.md` and the phase file give spec compliance; they do not widen scope.
|
||||
- Scope is Focused and decided: the exact change set of this session (files created or modified by the phase or the quick task, or by the whole feature on Finalize, plus the tests and docs changed for it). Do not ask about scope. `overview.md` and the phase file give spec compliance; they do not widen scope.
|
||||
- The helper rule applies: a fresh helper runs the analysis when available, you verify every finding, and the report carries its Reviewed by line.
|
||||
- No commit instructions and no next-conversation routing mid-review; the way back out carries both.
|
||||
- The page takes the whole report: the "top 10 of 15+" rule does not apply, and tables go in the doc.
|
||||
@@ -48,6 +49,8 @@ In loop mode the way out is the `loopOutcome` post, not a sign-off.
|
||||
|
||||
`show` runs as `notes/implement.md` says and reopens this card without it. Approving now covers the fixes: there is no separate "Check the fixes" step. On approval continue at `notes/implement.md` (the finish).
|
||||
|
||||
**`finalize`: the closing gate, then Step 3.** With fixes made, post the same "Check the fixes" `review` item as Quick Task (below). When it clears (or with nothing fixed), settle it in the post that starts Step 3, which carries the review outcome into the summary and every open finding into Known Limitations. No finish here; the `review` doc stays as a tab.
|
||||
|
||||
**`quick-task`: the closing gate, then the finish.** Post a `review` item "Check the fixes": `doc:"review"`, `"nothingYet":false`, verdicts `approve` ("The fixes look right") and `changes`, token `approved` / `needs changes`. When it clears, settle it in the same post as the new finish, posted without `review` and with `dashboard:true`; keep waiting for its buttons, `stop` only on `__done`. The finish:
|
||||
|
||||
- `headline`: "The review is done"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Helpers (Subagents)
|
||||
|
||||
The console points here when a `Subagents:` block reaches you. On the skills that offer it (`init`, `init-update`, `pathfinder`, `plan`, `revise-plan`, `document`, `implement`, `implement-review`, `quick-task`, `review`, `xray`, `diagnose`) the person turns helpers on or off from the top bar's Subagents button, per project and skill. It reaches you as a standing instruction, only when it changes.
|
||||
The console points here when a `Subagents:` block reaches you. On the skills that offer it (`init`, `init-update`, `pathfinder`, `plan`, `revise-plan`, `document`, `implement`, `implement-review`, `quick-task`, `review`, `finalize`, `xray`, `diagnose`) the person turns helpers on or off from the top bar's Subagents button, per project and skill. It reaches you as a standing instruction, only when it changes.
|
||||
|
||||
## What arrives
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
| --- | --- |
|
||||
| 1, Audit | Table as doc `audit`. If `totals.incomplete + totals.blocked > 0`, a `choice` (return, mark partial, abandon) with counts against thresholds in `body`. |
|
||||
| 2, Verification | Results as a doc; ask only on an issue. Unless Full Suite is `Never` or `At Phase N`: `confirm` "Run the full suite" (`yesLabel` "Run it", `noLabel` "Skip it", reason in `body`); a failure is the building notes' `choice`. |
|
||||
| 2.5, Final review | Always: `confirm` "Run a final review" (`yesLabel` "Review it", `noLabel` "Skip it", files and ~lines in `body`). Yes: `building-review.md`, the `finalize` door. |
|
||||
| 3, Summary | Written to `overview.md`; mirror it as a doc (`saved`, `file` block). |
|
||||
| 4, Docs review | Proposed-updates table as a doc, plus a `multi` of documents (ticked = approved, `required:false` so Skip means no doc changes); a `review` if all-or-nothing. |
|
||||
| 5, Feedback | `required:false`: rating as `choice` 1 to 10 or `text`, three reasons as `text`, maintainer consent as `confirm`. |
|
||||
@@ -11,4 +12,4 @@
|
||||
|
||||
Post `activity` as each step starts. Pass `--spec specs/<feature>` or post `specDir`.
|
||||
|
||||
Finish: the completion summary goes in `body`. `command` is the suggested commit when Step 4 updates landed (`"where":"When you are happy with it, commit it from your terminal:"`, `"commit":true`, `"changelog":true`), else none. A stop loses nothing before Step 3's write: `command` `/plan2code-4-finalize specs/<feature>/overview.md`.
|
||||
Finish: the completion summary goes in `body`. `command` is the suggested commit when review fixes or Step 4 updates landed (`"where":"When you are happy with it, commit it from your terminal:"`, `"commit":true`, `"changelog":true`), else none. A stop loses nothing before Step 3's write: `command` `/plan2code-4-finalize specs/<feature>/overview.md`.
|
||||
@@ -283,7 +283,7 @@ export const SKILLS = Object.freeze([
|
||||
pose: "finalize",
|
||||
builds: false, phased: false, metered: true, templates: false,
|
||||
weight: 1, started: "Finalize started", ran: "Finalize run", resume: "overview",
|
||||
subagents: null,
|
||||
subagents: "Run Step 2.5's final review analysis in one fresh helper briefed only with the spec and the feature's change set (references/reviewer-brief.md); verify every finding yourself before you report. Keep the audit, every question, the fixes and the archive with you. At standard strength or above (strongest when the feature touches security, auth or data), high effort.",
|
||||
states: ["built"], marksNext: true,
|
||||
greyed: { default: "Needs a spec that is fully built" },
|
||||
card: {
|
||||
|
||||
Reference in new issue
Block a user