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
Copy file name to clipboardExpand all lines: docs_build/dev/PROJECT_INSTRUCTIONS.md
+24-19Lines changed: 24 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,9 @@ Workflow:
6
6
PLAN_PR → BUILD_PR → APPLY_PR
7
7
8
8
PR lifecycle gate:
9
-
PR Open → Building → Validation → Approved → Merged → Main Verified → Closed
9
+
PR Open → Plan → Build → Validation → Approved → Merged → Main Verified → Closed
10
10
11
-
The PLAN_PR → BUILD_PR → APPLY_PR workflow remains preserved. PR Open is the first lifecycle status for active work, and Closed is the final repository-state gate.
11
+
The PLAN_PR → BUILD_PR → APPLY_PR workflow remains preserved. PR Open is the first lifecycle status for active work, Plan happens after PR Open on the same PR branch, and Closed is the final repository-state gate.
12
12
13
13
# WORKFLOW & EXECUTION
14
14
@@ -54,35 +54,39 @@ Rules:
54
54
Required state order:
55
55
56
56
1. PR Open
57
-
2. Building
58
-
3. Validation
59
-
4. Approved
60
-
5. Merged
61
-
6. Main Verified
62
-
7. Closed
57
+
2. Plan
58
+
3. Build
59
+
4. Validation
60
+
5. Approved
61
+
6. Merged
62
+
7. Main Verified
63
+
8. Closed
63
64
64
65
Definitions:
65
66
- PR Open is the first active lifecycle state.
66
-
- PR Open means the PR or branch has been created and named, and the work has a tracked PR identity before implementation begins.
67
+
- PR Open means the tracked PR identity and source branch have been created and named before Plan begins.
68
+
- Plan happens after PR Open on the same PR branch.
69
+
- Build, validation, reports, ZIP packaging, and closeout stay tied to that same PR identity and source branch.
67
70
- No BUILD_PR may proceed without a PR name and active branch/PR identity unless it is explicitly marked `PLAN_ONLY`.
68
-
-Building means scoped implementation, audit, report, validation, governance, or cleanup work is in progress for that PR identity.
71
+
-Build means scoped implementation, audit, report, validation, governance, or cleanup work is in progress for that PR identity.
69
72
- Validation means requested checks, required report creation, manual validation notes, and ZIP packaging are being completed.
70
-
- Approved means the owner or required reviewer has approved the PR outcome or intentionally approved closure without merge.
71
-
- Merged means the PR has merged or has been intentionally closed without merge with the reason recorded.
73
+
- Approved means the owner or required reviewer has approved the PR outcome for merge.
74
+
- Merged means the PR has merged and changes have been pushed.
72
75
- Main Verified means Codex is back on `main`, `main` includes the merge commit or recorded final commit, the worktree is clean, local/origin sync is `0/0`, and no untracked files remain.
73
76
- Closed means every Closed gate below is PASS.
74
77
75
78
Closed is valid only when all are PASS:
76
-
- PR merged or intentionally closed without merge with reason recorded.
77
-
- Changes pushed.
79
+
- PR merged and changes pushed.
78
80
- Current branch is `main`.
79
81
-`main` includes the merge commit or recorded final commit.
80
82
- Worktree clean.
81
83
- Local/origin sync is `0/0`.
82
84
- No untracked files.
83
-
- Branch disposition recorded as `deleted`, `retained for follow-up`, or `archived`.
85
+
- Branch disposition recorded as `retained`.
84
86
- Required reports exist.
85
87
- Required repo-structured ZIP under `tmp/` exists.
88
+
- Backlog updated.
89
+
- Tool state updated when applicable.
86
90
87
91
Hard stop:
88
92
- A team must not begin another PR if its previous PR is not Closed.
@@ -99,6 +103,8 @@ FINAL REPOSITORY STATE:
99
103
- PR status
100
104
- Merge/final commit
101
105
- Branch disposition
106
+
- Backlog update status
107
+
- Tool state update status
102
108
- ZIP path
103
109
- Closeout PASS/FAIL
104
110
```
@@ -2167,7 +2173,7 @@ Each reviewed item must be classified as one of:
2167
2173
- Historical/Archive
2168
2174
2169
2175
Rules:
2170
-
- Merged branches should be deleted after successful merge and main sync.
2176
+
- Merged source branches should be retained by default after successful merge and main sync.
2171
2177
- Superseded draft PRs should be closed.
2172
2178
- Abandoned branches should be documented before removal.
2173
2179
- Active workstream branches remain.
@@ -2193,7 +2199,7 @@ Required PI closeout report fields:
2193
2199
- active PRs
2194
2200
- active branches
2195
2201
- closed/superseded PRs
2196
-
-deleted branch candidates
2202
+
-retained branch disposition and any owner-approved deletion candidates
Copy file name to clipboardExpand all lines: docs_build/dev/ProjectInstructions/addendums/branch_lock_governance.md
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,8 @@ Keep active work attached to the correct assigned team, branch, and OWNER decisi
15
15
- A team with no active assignment, active branch, or active PR is inactive.
16
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
17
- PR Open begins only after the branch and PR identity are named.
18
-
- Closed ends only after the final main-return, clean-worktree, local/origin `0/0`, no-untracked-files, required-report, required-ZIP, and branch-disposition gates pass.
18
+
- Plan, Build, validation, reports, ZIP packaging, and closeout stay tied to the same PR identity and source branch.
19
+
- 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.
19
20
- Project Instructions must not assume a permanent team roster.
20
21
21
22
## Branch Rules
@@ -25,7 +26,8 @@ Keep active work attached to the correct assigned team, branch, and OWNER decisi
25
26
- Keep work on the active branch until the PR is merged, the branch is retired, or OWNER says to return to `main`.
26
27
- Do not commit directly to `main` unless OWNER explicitly approves.
27
28
- Do not merge stale historical branches directly unless they are current, clean, still needed, and OWNER-approved.
28
-
- Record branch disposition before Closed as one of: `deleted`, `retained for follow-up`, or `archived`.
29
+
- Retain source branches by default after merge and closeout.
30
+
- Record branch disposition before Closed as `retained`.
Copy file name to clipboardExpand all lines: docs_build/dev/ProjectInstructions/addendums/multi_team.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -151,7 +151,7 @@ Required steps:
151
151
5. Record final main commit.
152
152
6. Report final repository state.
153
153
7. Produce a repo-structured ZIP under `tmp/` that includes the EOD report and all changed or preserved repo files from the closeout.
154
-
8. Record branch disposition as `deleted`, `retained for follow-up`, or `archived`.
154
+
8. Record source branch disposition as `retained`.
155
155
9. Mark the PR Closed only when every Closed gate passes.
156
156
157
157
Required final state:
@@ -170,7 +170,9 @@ Rules:
170
170
- A workstream is not considered closed until the repository is returned to main.
171
171
- A PI is not considered complete until main is current and synchronized.
172
172
- Do not leave Codex on a feature, team, workstream, recovery, governance, or owner branch after successful merge.
173
-
- A PR is not Closed until the PR merged or an intentional no-merge close reason is recorded, changes are pushed, the repository is on `main`, `main` includes the merge or final commit, the worktree is clean, local/origin sync is `0/0`, no untracked files exist, branch disposition is recorded, required reports exist, and the required repo-structured ZIP exists under `tmp/`.
173
+
- Plan, Build, validation, reports, ZIP packaging, and closeout stay tied to the same PR identity and source branch.
174
+
- Source branches are retained by default after merge and closeout.
175
+
- A PR is not Closed until the PR merged, changes are pushed, the repository is on `main`, `main` includes the merge or final commit, the worktree is clean, local/origin sync is `0/0`, no untracked files exist, branch disposition is recorded as `retained`, required reports exist, the required repo-structured ZIP exists under `tmp/`, backlog is updated, and tool state is updated when applicable.
174
176
- A completed EOD closeout must produce the required ZIP even when the closeout changed no repo files; in that case, the ZIP must contain the EOD report proving the no-change result.
175
177
- The EOD ZIP does not replace the EOD report or other required reports under `docs_build/dev/reports/`.
176
178
- If merge succeeds but repository is not returned to main:
@@ -187,6 +189,8 @@ FINAL REPOSITORY STATE:
187
189
- PR status
188
190
- Merge/final commit
189
191
- Branch disposition
192
+
- Backlog update status
193
+
- Tool state update status
190
194
- ZIP path
191
195
- Closeout PASS/FAIL
192
196
```
@@ -209,7 +213,7 @@ Each reviewed item must be classified as one of:
209
213
- Historical/Archive
210
214
211
215
Rules:
212
-
- Merged branches should be deleted after successful merge and main sync.
216
+
- Merged source branches should be retained by default after successful merge and main sync.
213
217
- Superseded draft PRs should be closed.
214
218
- Abandoned branches should be documented before removal.
215
219
- Active workstream branches remain.
@@ -235,7 +239,7 @@ Required PI closeout report fields:
235
239
- active PRs
236
240
- active branches
237
241
- closed/superseded PRs
238
-
-deleted branch candidates
242
+
-retained branch disposition and any owner-approved deletion candidates
Copy file name to clipboardExpand all lines: docs_build/dev/ProjectInstructions/addendums/pr_workflow.md
+29-23Lines changed: 29 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,57 +14,63 @@ Define the standard pull request workflow for Game Foundry Studio.
14
14
3. Verify clean worktree.
15
15
4. Create a PR branch and PR identity.
16
16
5. Mark lifecycle state as PR Open.
17
-
6. Make scoped changes only.
18
-
7. Validate the change.
19
-
8. Commit with a clear OWNER/team message.
20
-
9. Push the branch.
21
-
10. Open or update the draft PR.
22
-
11. Review the PR.
23
-
12. OWNER approves merge or intentional close without merge.
24
-
13. Merge to main or record the approved no-merge close reason.
25
-
14. Pull latest main before starting the next PR.
26
-
15. Verify Main Verified and Closed gates.
17
+
6. Plan on the same PR branch.
18
+
7. Build on the same PR branch.
19
+
8. Validate the change.
20
+
9. Commit with a clear OWNER/team message.
21
+
10. Push the branch.
22
+
11. Open or update the draft PR.
23
+
12. Review the PR.
24
+
13. OWNER approves merge.
25
+
14. Merge to main.
26
+
15. Pull latest main before starting the next PR.
27
+
16. Verify Main Verified and Closed gates.
27
28
28
29
## PR Lifecycle States
29
30
30
31
Required state order:
31
32
32
33
1. PR Open
33
-
2. Building
34
-
3. Validation
35
-
4. Approved
36
-
5. Merged
37
-
6. Main Verified
38
-
7. Closed
34
+
2. Plan
35
+
3. Build
36
+
4. Validation
37
+
5. Approved
38
+
6. Merged
39
+
7. Main Verified
40
+
8. Closed
39
41
40
42
Definitions:
41
43
- PR Open is the first active lifecycle state.
42
-
- PR Open means the branch and PR identity are created and named before implementation begins.
44
+
- PR Open means the tracked PR identity and source branch are created and named before Plan begins.
45
+
- Plan happens after PR Open on the same PR branch.
43
46
- No BUILD_PR may proceed without a PR name and active branch/PR identity unless explicitly marked `PLAN_ONLY`.
44
-
-Building means scoped work is in progress.
47
+
-Build means scoped work is in progress on the same PR branch and PR identity.
45
48
- Validation means requested checks, required reports, manual validation notes, and ZIP packaging are underway.
46
-
- Approved means OWNER or required reviewer approval exists for merge or intentional close without merge.
47
-
- Merged means the PR merged, or the approved no-merge close reason is recorded.
49
+
- Approved means OWNER or required reviewer approval exists for merge.
50
+
- Merged means the PR merged and changes were pushed.
48
51
- Main Verified means current branch is `main`, `main` includes the merge or final commit, worktree is clean, local/origin sync is `0/0`, and no untracked files remain.
49
52
- Closed is valid only after every Closed gate passes.
50
53
51
54
Closed gates:
52
-
- PR merged or intentionally closed without merge with reason recorded.
53
-
- Changes pushed.
55
+
- PR merged and changes pushed.
54
56
- Current branch is `main`.
55
57
-`main` includes the merge commit or recorded final commit.
56
58
- Worktree clean.
57
59
- Local/origin sync is `0/0`.
58
60
- No untracked files.
59
-
- Branch disposition is recorded as `deleted`, `retained for follow-up`, or `archived`.
61
+
- Branch disposition is recorded as `retained`.
60
62
- Required reports exist.
61
63
- Required repo-structured ZIP under `tmp/` exists.
64
+
- Backlog is updated.
65
+
- Tool state is updated when applicable.
62
66
63
67
## Rules
64
68
65
69
- Direct commits to main are prohibited unless OWNER explicitly approves.
66
70
- Draft PRs are preferred until validation is complete.
67
71
- Each PR must have a clear scope.
72
+
- Plan, Build, validation, reports, ZIP packaging, and closeout must stay tied to the same PR identity and source branch.
73
+
- Source branches are retained by default after merge and closeout.
68
74
- Do not mix unrelated scopes.
69
75
- Do not start dependent PRs until the required base PR is merged.
70
76
- Always return to main before starting the next PR.
Copy file name to clipboardExpand all lines: docs_build/dev/ProjectInstructions/team_assignments/TEAM_ASSIGNMENTS.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -140,7 +140,8 @@ Rules:
140
140
- Each PR must create its own branch.
141
141
- Each PR must be committed, pushed, and opened as a draft PR.
142
142
- Each PR starts at PR Open after the branch and PR identity are named.
143
-
- Each PR reaches Closed only after main-return, clean-worktree, local/origin `0/0`, no-untracked-files, required-report, required-ZIP, and branch-disposition gates pass.
143
+
- Each PR plans and builds on the same source branch after PR Open.
144
+
- Each PR reaches Closed only after main-return, clean-worktree, local/origin `0/0`, no-untracked-files, required-report, required-ZIP, backlog, applicable tool-state, and retained-branch-disposition gates pass.
144
145
- A team must not begin another PR until its previous PR is Closed unless OWNER documented an explicit stacked PR chain.
145
146
- Do not commit directly to main.
146
147
- Do not merge without explicit owner approval.
@@ -168,7 +169,9 @@ Rules:
168
169
- Each PR must create or use its own approved branch.
169
170
- Each PR may be committed and pushed during active work.
170
171
- Each PR may be opened as a draft PR during active work.
171
-
- Each PR must move through PR Open, Building, Validation, Approved, Merged, Main Verified, and Closed in order.
172
+
- Each PR must move through PR Open, Plan, Build, Validation, Approved, Merged, Main Verified, and Closed in order.
173
+
- Plan, Build, validation, reports, ZIP packaging, and closeout must stay tied to the same PR identity and source branch.
174
+
- Source branches are retained by default after merge and closeout.
172
175
- A team must not begin another PR until its previous PR is Closed unless OWNER documented an explicit stacked PR chain.
173
176
- Do not commit directly to main.
174
177
- Do not merge to main during active work unless the owner explicitly says: "Merge this PR now."
0 commit comments