You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 86aed07
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs_build/dev/ProjectInstructions/addendums/branch_lock_governance.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,12 @@ Keep active work attached to the correct assigned team, branch, and OWNER decisi
9
9
10
10
## Active Work Lock
11
11
12
-
- Work must occur on the assigned team or OWNER branch.
12
+
- Work must occur on the active team branch.
13
+
- This rule applies to all teams: OWNER, Team Alfa, Team Bravo, Team Charlie, Team Delta, and any future team.
13
14
- An assigned work item keeps its owner of record until complete or OWNER reassignment.
14
15
- Work must not move to another team, branch, or PR without OWNER approval.
15
16
- A team with no active assignment, active branch, or active PR is inactive.
16
-
- A team with a previous PR that is not Closed must not begin another PR unless OWNER documented an explicit stacked PR chain.
17
+
- A team with a previous PR that is not Closed must not begin another unrelated PR unless OWNER documented an explicit stacked/sequential workstream.
17
18
- PR Open begins only after the branch and PR identity are named.
18
19
- Plan, Build, validation, reports, ZIP packaging, and closeout stay tied to the same PR identity and source branch.
19
20
- Closed ends only after the final main-return, clean-worktree, local/origin `0/0`, no-untracked-files, required-report, required-ZIP, backlog, applicable tool-state, and branch-disposition gates pass.
@@ -25,7 +26,8 @@ Keep active work attached to the correct assigned team, branch, and OWNER decisi
25
26
- Pull latest `origin/main` before creating a work branch.
26
27
- Do not create a PR branch unless current branch is `main`, worktree is clean, `main...origin/main` is `0 0`, and `HEAD` SHA matches the published EOD SHA.
27
28
- Follow the canonical START / WORK / END lifecycle in `docs_build/dev/ProjectInstructions/addendums/project_instructions_single_source_eod_lock.md`.
28
-
- Keep work on the active branch until the PR is merged, the branch is retired, or OWNER says to return to `main`.
29
+
- Keep work on the active branch until the PR is merged, the branch is retired, EOD closeout begins, or OWNER says to return to `main`.
30
+
- For OWNER-approved stacked/sequential workstreams, PR branches/commits stay on the active team branch/workstream during the day and do not return to `main` between PRs.
29
31
- Do not commit directly to `main`.
30
32
- HARD STOP before committing if current branch is `main`.
31
33
- HARD STOP if the branch changes unexpectedly during implementation.
- END by merging, returning to synchronized `main`, publishing branch, HEAD SHA, and date/time, then stopping all work.
54
-
- Mandatory hard stops before commits on `main`, dirty branch creation, non-`0 0` main sync, baseline SHA mismatch, unvalidated merge, or new PR work before synchronized main return.
56
+
- Mandatory hard stops before commits on `main`, dirty branch creation, non-`0 0` main sync, baseline SHA mismatch, unvalidated merge, or new unrelated workstream before synchronized main return.
Copy file name to clipboardExpand all lines: docs_build/dev/ProjectInstructions/addendums/no_mock_repository_runtime_source.md
+9-3Lines changed: 9 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,10 +11,16 @@ Browser → API → Database
11
11
12
12
Runtime product data must flow through the API/service contract backed by the database.
13
13
14
+
Canonical ASCII wording for this required flow is:
15
+
16
+
```text
17
+
Browser -> API -> Database
18
+
```
19
+
14
20
## Rules
15
21
16
22
- Mock repositories are 100% technical debt.
17
-
- "Mock repository ready" is not a valid Creator-testable completion state.
23
+
- "Mock repository ready" is not a valid Product Owner testable completion state.
18
24
- Page arrays are not product-data sources of truth.
19
25
- JSON source files are not product-data sources of truth.
20
26
-`/tmp` files are not product-data sources of truth.
@@ -32,7 +38,7 @@ If a temporary mock repository exists for transition, it must be documented as t
32
38
- affected files
33
39
- removal PR
34
40
- replacement API/DB path
35
-
-Creator-testable limitation
41
+
-Product Owner testable limitation
36
42
37
43
Temporary mock repositories do not make a feature complete. They may only document a transition state.
38
44
@@ -46,4 +52,4 @@ Completion requires Game Configuration data to load through:
46
52
Browser → API → Database
47
53
```
48
54
49
-
The Creator-testable completion state must prove that browser-visible Game Configuration data was read back through the API/service contract backed by the database.
55
+
The Product Owner testable completion state must prove that browser-visible Game Configuration data was read back through the API/service contract backed by the database.
Copy file name to clipboardExpand all lines: docs_build/dev/ProjectInstructions/addendums/pr_workflow.md
+64-4Lines changed: 64 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,9 +23,27 @@ Define the standard pull request workflow for Game Foundry Studio.
23
23
12. Review the PR.
24
24
13. OWNER approves merge.
25
25
14. Merge to main.
26
-
15. Pull latest main before starting the next PR.
26
+
15. Pull latest main before starting the next unrelated workstream, or before a new PR when the work is not an OWNER-approved stacked/sequential workstream.
27
27
16. Verify Main Verified and Closed gates.
28
28
29
+
## Daily Branch Workflow
30
+
31
+
Team-neutral daily workflow:
32
+
33
+
- SOD starts from the latest synchronized `main`.
34
+
- SOD creates or updates one active team branch/workstream.
35
+
- Work must be committed only to the active team branch.
36
+
- PR branches/commits stay on the active team branch/workstream during the day when OWNER assigned a stacked or sequential workstream.
37
+
- Do not return to `main` between stacked/sequential PRs in the same active workstream.
38
+
-`main` is only the SOD baseline and the EOD return target, unless OWNER explicitly approves an intermediate merge checkpoint.
39
+
- EOD merges or closes OWNER-approved work, pushes, returns to `main`, and verifies:
40
+
- current branch is `main`
41
+
- worktree clean
42
+
- local/origin sync is `0 0`
43
+
- This rule applies to all teams: OWNER, Team Alfa, Team Bravo, Team Charlie, Team Delta, and any future team.
44
+
45
+
This section supersedes older active wording that implies returning to `main` between every PR inside an OWNER-approved stacked/sequential workstream.
46
+
29
47
## Branch Lifecycle (Canonical)
30
48
31
49
Every PR follows exactly three phases:
@@ -101,7 +119,8 @@ Closed gates:
101
119
- Source branches are retained by default after merge and closeout.
102
120
- Do not mix unrelated scopes.
103
121
- Do not start dependent PRs until the required base PR is merged.
104
-
- Always return to main before starting the next PR.
122
+
- Return to `main` before starting an unrelated PR or new workstream.
123
+
- Do not return to `main` between PRs in the same OWNER-approved stacked/sequential workstream unless OWNER approves an EOD or intermediate merge checkpoint.
105
124
- A team must not begin another PR if its previous PR is not Closed.
106
125
- Exception is allowed only for explicitly documented stacked PR chains.
For tool MVPs, use one large Codex command, multiple focused stacked PRs, and one testable Creator outcome per PR.
146
+
For tool MVPs, use one large Codex command, multiple focused stacked PRs, and one Product Owner testable outcome per PR.
128
147
129
148
Do not create one giant PR.
130
149
131
150
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
151
133
152
Each tool MVP PR plan or template must include:
134
-
-Creator-testable outcome
153
+
-Product Owner testable outcome
135
154
- What Playwright tests
136
155
- What Mr. Q should manually test
137
156
- Whether the PR is part of a stacked MVP sequence
@@ -140,6 +159,47 @@ Each tool MVP PR plan or template must include:
140
159
141
160
Visible acceptance must be Creator-facing first. Architecture can be handled under the covers, but the PR purpose must be user-testable.
142
161
162
+
## Product Owner Testable Definition
163
+
164
+
A request to complete a page, tool, MVP, or testable experience means Product Owner testable by default. Codex must deliver a working Product Owner testable feature, not a shell or foundation page, unless the Product Owner explicitly requests a shell/foundation PR.
165
+
166
+
A Product Owner testable outcome means the Product Owner can:
167
+
168
+
- open the page/tool
169
+
- perform the primary workflow
170
+
- save/load data where applicable
171
+
- observe expected results
172
+
- validate success and failure states
173
+
- follow manual validation steps from the PR report
174
+
175
+
Not acceptable as a completed/testable page or tool:
176
+
177
+
- shell-only page
178
+
- route-only page
179
+
- navigation-only PR
180
+
- template-only page
181
+
- placeholder controls
182
+
- static table with no workflow
183
+
-`Not implemented yet`
184
+
-`coming soon`
185
+
- placeholder-only workspace, inspector, or output sections
186
+
- planned-only tile
187
+
- route that loads but cannot be used
188
+
189
+
Required for Product Owner testable completion:
190
+
191
+
- visible working controls
192
+
- API-backed data where required
193
+
- validation and error states
194
+
- empty states
195
+
- save/load behavior where applicable
196
+
- manual validation steps for Product Owner
197
+
- targeted Playwright coverage where impacted.
198
+
199
+
## No-Shell Completion Rule
200
+
201
+
A PR requested to complete a page, tool, MVP, or testable experience must not stop after route creation, shell creation, placeholder UI, static mock layout, or navigation activation unless the Product Owner explicitly requested a shell/foundation PR.
Copy file name to clipboardExpand all lines: docs_build/dev/ProjectInstructions/addendums/project_instructions_single_source_eod_lock.md
+8-3Lines changed: 8 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,7 +68,7 @@ END
68
68
69
69
## START
70
70
71
-
Every team begins on`main`.
71
+
Every team begins SOD from`main`.
72
72
73
73
Required:
74
74
@@ -91,7 +91,7 @@ main...origin/main
91
91
HEAD equals published EOD SHA
92
92
```
93
93
94
-
Only after ALL four pass may a branch be created.
94
+
Only after ALL four pass may a branch be created or the active team branch/workstream be updated.
95
95
96
96
Create the PR branch:
97
97
@@ -112,9 +112,13 @@ From branch creation until merge:
112
112
- Remain on the PR branch.
113
113
- Never checkout `main`.
114
114
- Commit only on the PR branch.
115
+
- Work must be committed only to the active team branch.
115
116
- Push only the PR branch.
116
117
- Execute validation from the PR branch.
117
118
- Open/update the PR from the PR branch.
119
+
- For OWNER-approved stacked/sequential workstreams, PR branches/commits stay on the active team branch/workstream between sequential PRs during the day.
120
+
- Do not return to `main` between sequential PRs in the same active workstream unless OWNER explicitly approves an EOD or intermediate merge checkpoint.
121
+
- This rule applies to all teams: OWNER, Team Alfa, Team Bravo, Team Charlie, Team Delta, and any future team.
118
122
119
123
Hard Stops:
120
124
@@ -192,7 +196,8 @@ STOP if:
192
196
-`main...origin/main` is not `0 0` before creating PR branch
193
197
-`HEAD` SHA differs from published baseline
194
198
- merge attempted without successful validation
195
-
- new PR started before returning to synchronized `main`
199
+
- new unrelated PR or workstream started before returning to synchronized `main`
200
+
- sequential work continues without an OWNER-approved stacked/sequential workstream model
- Every user-accessible page must have at least one matching page-level Playwright test before it can be considered complete.
38
+
- Runtime page path determines the page-level Playwright test path.
39
+
- Primary page-level Playwright test file should be `index.spec.mjs`.
40
+
- Do not organize new page-level Playwright tests only by feature nickname or technology bucket when a page path exists.
41
+
- Legacy broad tests may remain while migration is planned; document migration/deprecation instead of moving broad legacy tests unless the PR scope requires it.
Copy file name to clipboardExpand all lines: docs_build/dev/ProjectInstructions/addendums/tool_mvp_stacked_pr_standard.md
+45-4Lines changed: 45 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,15 +12,15 @@ Define how Codex plans and executes Creator-facing tool MVP work without creatin
12
12
For tool MVPs, use:
13
13
14
14
```text
15
-
One large Codex command -> multiple focused stacked PRs -> each PR has a testable Creator outcome.
15
+
One large Codex command -> multiple focused stacked PRs -> each PR has a Product Owner testable outcome.
16
16
```
17
17
18
18
## Rules
19
19
20
20
- Do not create one giant PR.
21
21
- Do not stop after every small PR unless blocked.
22
22
- Each PR must be independently scoped.
23
-
- Each PR must produce a Creator-testable outcome.
23
+
- Each PR must produce a Product Owner testable outcome.
24
24
- Each PR must answer:
25
25
26
26
```text
@@ -40,8 +40,43 @@ For tool MVP PR planning, visible acceptance must be Creator-facing first.
40
40
41
41
Architecture can be handled under the covers, but PR purpose must be user-testable.
42
42
43
+
A request to complete a page, tool, MVP, or testable experience means Product Owner testable by default. Codex must deliver a working Product Owner testable feature, not a shell or foundation page, unless the Product Owner explicitly requests a shell/foundation PR.
44
+
45
+
A Product Owner testable outcome means the Product Owner can:
46
+
47
+
- open the page/tool
48
+
- perform the primary workflow
49
+
- save/load data where applicable
50
+
- observe expected results
51
+
- validate success and failure states
52
+
- follow manual validation steps from the PR report
53
+
54
+
Not acceptable as complete/testable:
55
+
56
+
- shell-only page
57
+
- route-only page
58
+
- navigation-only PR
59
+
- template-only page
60
+
- placeholder controls
61
+
- static table with no workflow
62
+
-`Not implemented yet`
63
+
-`coming soon`
64
+
- placeholder-only workspace, inspector, or output sections
65
+
- planned-only tile
66
+
- route that loads but cannot be used
67
+
68
+
Required for Product Owner testable completion:
69
+
70
+
- visible working controls
71
+
- API-backed data where required
72
+
- validation and error states
73
+
- empty states
74
+
- save/load behavior where applicable
75
+
- manual validation steps for Product Owner
76
+
- targeted Playwright coverage where impacted.
77
+
43
78
Each tool MVP PR must state:
44
-
-Creator-testable outcome
79
+
-Product Owner testable outcome
45
80
- What Playwright tests
46
81
- What Mr. Q should manually test
47
82
- Whether the PR is part of a stacked MVP sequence
@@ -50,6 +85,8 @@ Each tool MVP PR must state:
50
85
51
86
## Runtime Data Completion Boundary
52
87
88
+
A PR requested to complete a page, tool, MVP, or testable experience must not stop after route creation, shell creation, placeholder UI, static mock layout, or navigation activation unless the Product Owner explicitly requested a shell/foundation PR.
89
+
53
90
A PR outcome must not be described as complete if the visible data is coming from:
54
91
55
92
- mock repositories
@@ -81,4 +118,8 @@ Each PR in the stack still follows the canonical START / WORK / END lifecycle an
81
118
82
119
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.
83
120
84
-
The final PR in the stack must perform normal closeout and stop all work after returning to synchronized main.
121
+
During an OWNER-approved day workstream, PR branches/commits stay on the active team branch/workstream and do not return to `main` between PRs.
122
+
123
+
This rule applies to all teams: OWNER, Team Alfa, Team Bravo, Team Charlie, Team Delta, and any future team.
124
+
125
+
The final PR in the stack must perform normal EOD closeout or OWNER-approved merge-checkpoint closeout and stop all work after returning to synchronized main.
0 commit comments