Skip to content

Commit f31fa61

Browse files
committed
Add Tool MVP stacked PR standard
1 parent 2610fbb commit f31fa61

14 files changed

Lines changed: 281 additions & 58 deletions

docs_build/dev/ProjectInstructions/PROJECT_INSTRUCTIONS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ Existing Project Instructions outside `docs_build/dev/ProjectInstructions/` rema
5656

5757
`docs_build/dev/ProjectInstructions/addendums/koti_layout_contract.md` defines the King of the Iceberg layout data contract.
5858

59+
`docs_build/dev/ProjectInstructions/addendums/tool_mvp_stacked_pr_standard.md` defines the Creator-facing stacked PR standard for tool MVP work.
60+
5961
## Single Source and Main Lock Governance
6062

6163
`docs_build/dev/ProjectInstructions/addendums/project_instructions_single_source_eod_lock.md` defines the single active Project Instructions source, canonical START / WORK / END branch lifecycle, EOD main lock, next-day reset, team branch creation gate, daily synchronization baseline, and mandatory hard stops.

docs_build/dev/ProjectInstructions/README.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,4 @@ Addendum index:
5959
- Workspace V2 Playwright Gate: docs_build/dev/ProjectInstructions/addendums/workspace_v2_playwright_gate.md
6060
- Samples2Tools Adapter Guidance: docs_build/dev/ProjectInstructions/addendums/samples2tools_adapter_guidance.md
6161
- King of the Iceberg Layout Contract: docs_build/dev/ProjectInstructions/addendums/koti_layout_contract.md
62+
- Tool MVP Stacked PR Standard: docs_build/dev/ProjectInstructions/addendums/tool_mvp_stacked_pr_standard.md

docs_build/dev/ProjectInstructions/addendums/codex_artifact_and_reporting_standard.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,24 @@ Codex responses must include:
3434
- Merge commit(s)
3535
- Validation results
3636

37+
## Tool MVP PR Report Requirements
38+
39+
Every tool MVP PR report must include:
40+
- Creator-testable outcome
41+
- What Playwright tests
42+
- What Mr. Q should manually test
43+
- Whether the PR is part of a stacked MVP sequence
44+
- Previous PR dependency
45+
- Next PR dependency
46+
47+
The report must answer:
48+
49+
```text
50+
What can Mr. Q test after applying this ZIP?
51+
```
52+
53+
If a tool MVP PR has no Playwright lane, the report must state why and list the manual Creator validation instead.
54+
3755
## Code Change Reporting
3856

3957
When a ZIP is uploaded, report executable code changes only.

docs_build/dev/ProjectInstructions/addendums/pr_workflow.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,28 @@ For governance, documentation, and administrative work, use Batch Governance Mod
118118

119119
Use stacked sequential PRs only when dependency order requires it.
120120

121+
## Tool MVP Stacked PRs
122+
123+
Tool MVP work must follow:
124+
125+
`docs_build/dev/ProjectInstructions/addendums/tool_mvp_stacked_pr_standard.md`
126+
127+
For tool MVPs, use one large Codex command, multiple focused stacked PRs, and one testable Creator outcome per PR.
128+
129+
Do not create one giant PR.
130+
131+
Do not stop after every small PR unless blocked by branch state, failed validation, missing source files, Project Instructions conflict, or an unresolved dependency from a prior PR.
132+
133+
Each tool MVP PR plan or template must include:
134+
- Creator-testable outcome
135+
- What Playwright tests
136+
- What Mr. Q should manually test
137+
- Whether the PR is part of a stacked MVP sequence
138+
- Previous PR dependency
139+
- Next PR dependency
140+
141+
Visible acceptance must be Creator-facing first. Architecture can be handled under the covers, but the PR purpose must be user-testable.
142+
121143
## OWNER Shortcut: PRs
122144

123145
Keyword:

docs_build/dev/ProjectInstructions/addendums/release_gate.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ The release gate should confirm these files when relevant to the PR:
4444
- `docs_build/dev/ProjectInstructions/addendums/workspace_v2_playwright_gate.md`
4545
- `docs_build/dev/ProjectInstructions/addendums/samples2tools_adapter_guidance.md`
4646
- `docs_build/dev/ProjectInstructions/addendums/koti_layout_contract.md`
47+
- `docs_build/dev/ProjectInstructions/addendums/tool_mvp_stacked_pr_standard.md`
4748
- `docs_build/dev/ProjectInstructions/team_assignments/team_ownership.md`
4849
- `docs_build/dev/admin-notes/Installs required.txt` when present
4950
- `docs_build/dev/admin-notes/Table layout.txt` when present
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Tool MVP Stacked PR Standard
2+
3+
Status: Approved
4+
Owner: OWNER
5+
6+
## Purpose
7+
8+
Define how Codex plans and executes Creator-facing tool MVP work without creating one giant PR or stopping after every small PR.
9+
10+
## Standard
11+
12+
For tool MVPs, use:
13+
14+
```text
15+
One large Codex command -> multiple focused stacked PRs -> each PR has a testable Creator outcome.
16+
```
17+
18+
## Rules
19+
20+
- Do not create one giant PR.
21+
- Do not stop after every small PR unless blocked.
22+
- Each PR must be independently scoped.
23+
- Each PR must produce a Creator-testable outcome.
24+
- Each PR must answer:
25+
26+
```text
27+
What can Mr. Q test after applying this ZIP?
28+
```
29+
30+
- Codex must continue through the stacked PR sequence unless blocked by:
31+
- branch state
32+
- failed validation
33+
- missing source files
34+
- Project Instructions conflict
35+
- unresolved dependency from a prior PR
36+
37+
## Creator-Facing Acceptance
38+
39+
For tool MVP PR planning, visible acceptance must be Creator-facing first.
40+
41+
Architecture can be handled under the covers, but PR purpose must be user-testable.
42+
43+
Each tool MVP PR must state:
44+
- Creator-testable outcome
45+
- What Playwright tests
46+
- What Mr. Q should manually test
47+
- Whether the PR is part of a stacked MVP sequence
48+
- Previous PR dependency
49+
- Next PR dependency
50+
51+
## Hitboxes MVP Example Stack
52+
53+
Example Hitboxes MVP stack:
54+
55+
- PR 1: Creator can open the tool and choose a real/test object.
56+
- PR 2: Creator can see the object and draw a rectangle hitbox.
57+
- PR 3: Creator can move/resize/save/reload hitboxes.
58+
- PR 4: Creator can test Object A vs Object B collision.
59+
- PR 5: Creator can test speed/animation so fast objects do not skip collision.
60+
- PR 6: Polish and regression coverage.
61+
62+
## Lifecycle Relationship
63+
64+
Tool MVP stacks are explicitly documented stacked PR chains.
65+
66+
Each PR in the stack still follows the canonical START / WORK / END lifecycle and must produce required reports and a repo-structured ZIP.
67+
68+
When OWNER gives one large Codex command for a tool MVP stack, Codex may continue from one completed PR to the next without stopping for a conversational checkpoint, unless a blocker listed in this standard occurs.
69+
70+
The final PR in the stack must perform normal closeout and stop all work after returning to synchronized main.

docs_build/dev/pr/BUILD_PR.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ This `docs_build/dev/pr/BUILD_PR.md`, `docs_build/dev/pr/PLAN_PR.md`, and the us
1818
- Move active governance/contract docs from `docs_build/dev/` root into `docs_build/dev/ProjectInstructions/addendums/`.
1919
- Move audit outputs from `docs_build/dev/` root into `docs_build/dev/reports/audits/`.
2020
- Delete stale one-off bundle metadata from `docs_build/dev/` root.
21+
- Add Tool MVP Stacked PR Standard under `docs_build/dev/ProjectInstructions/`.
22+
- Update PR planning/template and report requirements for tool MVP PRs.
2123
- Keep preserved historical ProjectInstructions material reference-only.
2224
- Keep `project-instructions/` out of this PR except for a tiny deprecated pointer.
2325
- Update active team start/governance docs to reference only `docs_build/dev/ProjectInstructions/`.
@@ -34,6 +36,7 @@ This `docs_build/dev/pr/BUILD_PR.md`, `docs_build/dev/pr/PLAN_PR.md`, and the us
3436
- `docs_build/dev/ProjectInstructions/TEAM_START_COMMANDS.md`
3537
- `docs_build/dev/ProjectInstructions/team_assignments/TEAM_ASSIGNMENTS.md`
3638
- `docs_build/dev/ProjectInstructions/addendums/*.md`
39+
- `docs_build/dev/ProjectInstructions/addendums/tool_mvp_stacked_pr_standard.md`
3740
- `docs_build/dev/reports/audits/*.md`
3841
- `project-instructions/README.md` (tiny deprecated pointer only)
3942
- `docs_build/dev/PROJECT_INSTRUCTIONS.md` (delete)
@@ -86,6 +89,7 @@ Test-Path docs_build/dev/css-audit.md
8689
Test-Path docs_build/dev/bundle_readme.md
8790
Test-Path docs_build/dev/validation_checklist.txt
8891
rg -n 'only active Project Instructions source|docs_build/dev/ProjectInstructions/' docs_build/dev/ProjectInstructions
92+
rg -n 'Tool MVP Stacked PR Standard|Creator-testable outcome|What can Mr\\. Q test after applying this ZIP|What Playwright tests|What Mr\\. Q should manually test|Previous PR dependency|Next PR dependency' docs_build/dev/ProjectInstructions
8993
rg -n 'docs_build/dev/PROJECT_INSTRUCTIONS.md.*source of truth|Codex must always read `docs_build/dev/PROJECT_INSTRUCTIONS.md`|Read `docs_build/dev/PROJECT_INSTRUCTIONS.md`' docs_build/dev/ProjectInstructions project-instructions
9094
git diff --name-status $(git merge-base HEAD origin/main) -- project-instructions
9195
git diff --name-status $(git merge-base HEAD origin/main) -- docs_build/dev/pr docs_build/dev/ProjectInstructions/addendums docs_build/dev/reports/audits

docs_build/dev/pr/PLAN_PR.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Make `docs_build/dev/ProjectInstructions/` the only active Project Instructions
1313
- Move active governance/contract docs from `docs_build/dev/` root into `docs_build/dev/ProjectInstructions/addendums/`.
1414
- Move audit outputs from `docs_build/dev/` root into `docs_build/dev/reports/audits/`.
1515
- Delete stale one-off bundle metadata from `docs_build/dev/` root.
16+
- Add Tool MVP Stacked PR Standard under `docs_build/dev/ProjectInstructions/`.
17+
- Update PR planning/template and report requirements for tool MVP PRs.
1618
- Preserve historical ProjectInstructions-style sources only as deprecated reference material.
1719
- Keep `project-instructions/` out of the PR except for a tiny deprecated pointer.
1820
- Move active legacy addendums into `docs_build/dev/ProjectInstructions/addendums/`.
@@ -35,6 +37,8 @@ Make `docs_build/dev/ProjectInstructions/` the only active Project Instructions
3537
4. Confirm docs_build/dev root no longer contains active loose instruction, audit, contract, or PR files.
3638
5. Confirm moved active governance/contract docs are under `docs_build/dev/ProjectInstructions/addendums/`.
3739
6. Confirm moved audit outputs are under `docs_build/dev/reports/audits/`.
38-
7. Confirm EOD/Next Day and canonical START / WORK / END branch lifecycle rules appear in active governance docs.
39-
8. Confirm no product/runtime files changed.
40-
9. Run `git diff --check`.
40+
7. Confirm Tool MVP Stacked PR Standard appears in active ProjectInstructions.
41+
8. Confirm tool MVP PR template/report requirements include Creator-testable outcome, Playwright tests, Mr. Q manual test, stack membership, and previous/next dependency.
42+
9. Confirm EOD/Next Day and canonical START / WORK / END branch lifecycle rules appear in active governance docs.
43+
10. Confirm no product/runtime files changed.
44+
11. Run `git diff --check`.

docs_build/dev/reports/PR_26177_OWNER_007-project-instructions-single-source-eod-lock.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Date: 2026-06-26
44
Branch: PR_26177_OWNER_007-project-instructions-single-source-eod-lock
5-
Scope: Project Instructions single-source governance, EOD main lock, branch lifecycle governance, and docs_build/dev root cleanup
5+
Scope: Project Instructions single-source governance, EOD main lock, branch lifecycle governance, docs_build/dev root cleanup, and Tool MVP stacked PR governance
66
Status: PASS
77

88
## Summary
@@ -16,11 +16,26 @@ Status: PASS
1616
- Moved active governance/contract root docs into docs_build/dev/ProjectInstructions/addendums/.
1717
- Moved audit outputs into docs_build/dev/reports/audits/.
1818
- Deleted stale one-off bundle metadata from docs_build/dev root.
19+
- Added docs_build/dev/ProjectInstructions/addendums/tool_mvp_stacked_pr_standard.md.
20+
- Updated PR workflow governance so tool MVP PR plans/templates include Creator-testable outcome, Playwright test scope, Mr. Q manual test scope, stacked MVP sequence membership, and previous/next PR dependencies.
21+
- Updated Codex artifact/reporting governance so every tool MVP PR report includes those same fields and answers what Mr. Q can test after applying the ZIP.
1922
- Corrected project-instructions/** scope so the PR only adds a tiny deprecated pointer README there.
2023
- Preserved project-instructions/addendums/** unchanged in the PR; unique current governance content is carried by docs_build/dev/ProjectInstructions/addendums/.
2124
- Confirmed docs_build/dev root no longer contains active loose instruction, audit, contract, or PR files.
2225
- No product/runtime, start_of_day, feature, or legacy SQLite file changes were made.
2326

27+
## Tool MVP Stacked PR Standard
28+
29+
Added governance:
30+
- One large Codex command -> multiple focused stacked PRs -> each PR has a testable Creator outcome.
31+
- No one giant PR.
32+
- No stopping after every small PR unless blocked.
33+
- Each PR is independently scoped and Creator-testable.
34+
- Each PR answers: What can Mr. Q test after applying this ZIP?
35+
- Codex continues through the stack unless blocked by branch state, failed validation, missing source files, Project Instructions conflict, or unresolved prior-PR dependency.
36+
- Visible acceptance for tool MVP planning is Creator-facing first.
37+
- Hitboxes MVP example stack is included.
38+
2439
## Moved To ProjectInstructions SSoT
2540

2641
- docs_build/dev/workspace_v2_playwright_gate.md -> docs_build/dev/ProjectInstructions/addendums/workspace_v2_playwright_gate.md
@@ -68,22 +83,16 @@ Deleted stale one-off root files:
6883
- docs_build/dev/bundle_readme.md
6984
- docs_build/dev/validation_checklist.txt
7085

71-
## Ambiguous Old Docs Handling
72-
73-
- Reviewed loose root docs before moving or deleting them.
74-
- Moved active/contract content into docs_build/dev/ProjectInstructions/addendums/.
75-
- Moved one-off PR docs into docs_build/dev/pr/ instead of deleting them by filename.
76-
- Moved audit outputs into docs_build/dev/reports/audits/.
77-
- Removed project-instructions/addendums/** edits from the PR so old files remain historical reference, not a second active source.
78-
- Added only project-instructions/README.md as a tiny deprecated pointer to docs_build/dev/ProjectInstructions/.
79-
8086
## Validation
8187

8288
- PASS: current branch is PR_26177_OWNER_007-project-instructions-single-source-eod-lock.
8389
- PASS: docs_build/dev root file list is empty after cleanup.
8490
- PASS: targeted path checks confirm duplicate root instruction files, moved root files, and listed stale one-off files are absent.
8591
- PASS: project-instructions/** PR diff is limited to project-instructions/README.md.
8692
- PASS: active moved governance/contract docs are indexed in docs_build/dev/ProjectInstructions/PROJECT_INSTRUCTIONS.md and README.txt.
93+
- PASS: Tool MVP Stacked PR Standard exists and includes required governance text.
94+
- PASS: PR workflow/template requirements include Creator-testable outcome, Playwright tests, Mr. Q manual test, stack membership, and previous/next dependency.
95+
- PASS: Codex report requirements include Creator-testable outcome, Playwright tests, Mr. Q manual test, stack membership, and previous/next dependency.
8796
- PASS: targeted grep found no active duplicate ProjectInstructions source-of-truth claim outside the active source.
8897
- PASS: targeted grep confirmed canonical lifecycle language appears in active governance docs.
8998
- PASS: product/runtime and start_of_day changed-file check returned no files.

docs_build/dev/reports/PR_26177_OWNER_007-project-instructions-single-source-eod-lock_branch-validation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Status: PASS
66
- PASS: Branch is not main during WORK.
77
- PASS: Worktree changes are scoped to governance/docs cleanup, reports, and the required delta artifact.
88
- PASS: docs_build/dev root contains no loose files after moving PR docs, active addendums, and audit outputs.
9+
- PASS: Tool MVP Stacked PR Standard was added under docs_build/dev/ProjectInstructions/addendums/.
910
- PASS: project-instructions/** is limited to a tiny deprecated pointer README in the PR diff.
1011
- PASS: No product/runtime files changed.
1112
- PASS: No start_of_day files changed.

0 commit comments

Comments
 (0)