|
1 | | -# Project Instructions Operating System |
2 | | - |
3 | | -Read `README.txt` first. |
4 | | - |
5 | | -This file is the root index for the append-first Project Instructions operating system under `dev/build/ProjectInstructions/`. |
6 | | - |
7 | | -## Active Source |
8 | | - |
9 | | -`dev/build/ProjectInstructions/` is the only active Project Instructions source. |
10 | | - |
11 | | -Historical Project Instructions material outside this folder is deprecated reference material only and must not be used as an active source of governance. |
| 1 | +# Project Instructions |
12 | 2 |
|
13 | 3 | ## Purpose |
14 | 4 |
|
15 | | -The Project Instructions operating system provides additive governance for: |
16 | | - |
17 | | -- backlog ownership |
18 | | -- team assignments |
19 | | -- multi-team branch and scope rules |
20 | | -- documentation ownership |
21 | | -- repository directory ownership |
22 | | -- Build Path status synchronization |
23 | | -- tile overlay status behavior |
24 | | -- deprecation workflow |
25 | | -- contract and platform standards |
26 | | -- archive and history preservation |
27 | | -- recognized project instruction/reference files |
28 | | -- environment governance |
29 | | -- tool and gameplay contract governance |
30 | | - |
31 | | -## Preservation |
32 | | - |
33 | | -Existing Project Instructions outside `dev/build/ProjectInstructions/` remain preserved only as deprecated reference material. When guidance conflicts, active files under `dev/build/ProjectInstructions/` win unless OWNER explicitly approves a newer governance change. |
34 | | - |
35 | | -## Folders |
36 | | - |
37 | | -- `addendums/` contains additive governance rules. |
38 | | -- `backlog/` contains the central backlog file, `BACKLOG_MASTER.md`. |
39 | | -- `team_assignments/` contains current team assignment records. |
40 | | -- `standards/` contains active contract, model, and platform standards. |
41 | | -- `deprecation/` contains deprecation workflow documentation. |
42 | | -- Retained reference material belongs under the repository root `dev/archive/` tree, not under `dev/build/dev/`. |
43 | | -- History snapshots belong under `dev/archive/legacy-docs-build/ProjectInstructions/history/`. |
44 | | - |
45 | | -## Recognized Project Reference Files |
46 | | - |
47 | | -`dev/build/ProjectInstructions/addendums/project_reference_files.md` defines additional valid project instruction/reference files that must be included in future Project Instructions reviews when present in `ProjectInstructions.zip`, the active project instruction directory, or the root archive reference tree. |
48 | | - |
49 | | -## Documentation Ownership |
50 | | - |
51 | | -`dev/build/ProjectInstructions/addendums/documentation_ownership.md` defines the active documentation ownership model: |
52 | | - |
53 | | -- `dev/build/ProjectInstructions/` owns governance, team instructions, standards, and addendums. |
54 | | -- `dev/build/pr/` owns PR workflow documents, templates, and examples. |
55 | | -- `dev/reports/` owns generated reports and audits. |
56 | | -- `dev/workspace/` owns generated non-report artifacts, repo-structured ZIPs, and local temporary workspace output. |
57 | | -- root `dev/archive/` owns historical reference material only. |
58 | | - |
59 | | -## Team Backlog, SOD, And EOD Governance |
60 | | - |
61 | | -`dev/build/ProjectInstructions/addendums/team_backlog_sod_eod_standard.md` defines required Start of Day team briefings, End of Day team summaries, active team backlog fields, completion percentage update points, backlog-driven next PR selection, and official military team-name spelling. |
62 | | - |
63 | | -## Canonical Governance Owners |
64 | | - |
65 | | -When active guidance overlaps, use these canonical owner documents: |
66 | | - |
67 | | -- Workflow and Product Owner testable completion: `dev/build/ProjectInstructions/addendums/pr_workflow.md` |
68 | | -- START / WORK / END lifecycle, branch gates, mandatory hard stops, and EOD main lock: `dev/build/ProjectInstructions/addendums/project_instructions_single_source_eod_lock.md` |
69 | | -- Repository directory ownership, final root standard, final `src/` layer standard, final `dev/` workspace standard, and restructure boundaries: `dev/build/ProjectInstructions/addendums/repository_directory_standard.md` |
70 | | -- Page-level Playwright organization and completion coverage: `dev/build/ProjectInstructions/addendums/test_structure_standardization.md` |
71 | | -- API/environment model and `Browser -> API -> Database` rule: `dev/build/ProjectInstructions/addendums/environment_governance_model.md` |
72 | | -- Environment variable, URL, R2 prefix, and feature flag configuration: `dev/build/ProjectInstructions/addendums/environment_configuration_standards.md` |
73 | | -- Team backlog fields, completion percentages, and next logical PR ownership: `dev/build/ProjectInstructions/addendums/team_backlog_sod_eod_standard.md` |
74 | | -- Team ownership and assignment routing: `dev/build/ProjectInstructions/team_assignments/team_ownership.md` |
75 | | - |
76 | | -Other active addendums may summarize these rules, but they must point back to the canonical owner document and must not create a competing active rule. |
77 | | - |
78 | | -## Environment Governance |
79 | | - |
80 | | -`dev/build/ProjectInstructions/addendums/environment_governance_model.md` defines the official environment model, environment invariance rule, shared API/service contract rule, required Supabase/Postgres/R2 services, required R2 prefixes, and SQLite retired status. |
81 | | - |
82 | | -`dev/build/ProjectInstructions/addendums/environment_configuration_standards.md` defines official `.env` file names, environment variable values, host/domain configuration, API URL configuration, R2 prefix configuration, and feature flag governance. |
83 | | - |
84 | | -## Tool And Contract Governance |
85 | | - |
86 | | -`dev/build/ProjectInstructions/addendums/workspace_v2_playwright_gate.md` defines the Workspace Manager V2 Playwright validation gate. |
87 | | - |
88 | | -`dev/build/ProjectInstructions/addendums/samples2tools_adapter_guidance.md` defines the shared sample-to-tool launch and hydration guidance. |
89 | | - |
90 | | -`dev/build/ProjectInstructions/addendums/koti_layout_contract.md` defines the King of the Iceberg layout data contract. |
91 | | - |
92 | | -`dev/build/ProjectInstructions/addendums/tool_mvp_stacked_pr_standard.md` defines the Creator-facing stacked PR standard for tool MVP work. |
93 | | - |
94 | | -`dev/build/ProjectInstructions/addendums/no_mock_repository_runtime_source.md` defines the Browser → API → Database product-data rule and mock repository technical debt boundary. |
95 | | - |
96 | | -## Standards |
97 | | - |
98 | | -Active contract, model, and platform standards live under: |
99 | | - |
100 | | -`dev/build/ProjectInstructions/standards/` |
101 | | - |
102 | | -## Single Source and Main Lock Governance |
103 | | - |
104 | | -`dev/build/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. |
105 | | - |
106 | | -## Merge Control |
107 | | - |
108 | | -No PR in this operating system is merged without explicit owner approval. |
109 | | - |
110 | | -## OWNER Governance |
111 | | - |
112 | | -OWNER override wording: |
113 | | - |
114 | | -`OWNER override approved: <reason>` |
115 | | - |
116 | | -OWNER follows the same safety rules: |
117 | | -- Team OWNER follows the same one-active-branch discipline as every team. |
118 | | -- One active OWNER assignment at a time. |
119 | | -- OWNER may override team locks, but may not silently delete, rewrite, or remove protected instructions. |
120 | | -- OWNER override must be explicitly documented. |
121 | | - |
122 | | -## Four-Team Ownership Alignment |
123 | | - |
124 | | -The single authoritative four-team ownership definition is: |
125 | | - |
126 | | -`dev/build/ProjectInstructions/team_assignments/team_ownership.md` |
127 | | - |
128 | | -Use the `Current Four-Team Ownership Model` section there for team ownership, assignment routing, and cross-team scope checks. |
129 | | - |
130 | | -Rules: |
131 | | -- Teams pull backlog items only from their ownership area unless OWNER explicitly reassigns or splits the work. |
132 | | -- Cross-team work requires OWNER approval and must identify the owning team for each PR. |
133 | | -- Team start commands must remain aligned with this ownership model. |
134 | | - |
135 | | -## Current Active Ownership Lanes |
136 | | - |
137 | | -OWNER override approved. |
138 | | - |
139 | | -The current active ownership lanes are: |
140 | | - |
141 | | -- Team Alfa |
142 | | -- Team Bravo |
143 | | -- Team Charlie |
144 | | -- Team Delta |
145 | | -- Team Golf |
146 | | -- Team OWNER |
147 | | - |
148 | | -Migration note: |
149 | | -Team Gamma is retired. Team Golf is the replacement active ownership lane. |
150 | | - |
151 | | -Rules: |
152 | | -- Do not rewrite historical PR references that mention Team Gamma. |
153 | | -- Do not rename historical branches that contain Gamma. |
154 | | -- Team Golf may own newly assigned work, review packets, cleanup, release, or OWNER-directed cross-team work. |
155 | | -- Team Golf must not silently take backlog ownership from Alfa, Bravo, Charlie, or Delta; cross-team work requires OWNER approval. |
| 5 | +`PROJECT_INSTRUCTIONS.md` is the only manual entry point for active Project Instructions. |
| 6 | + |
| 7 | +Codex and future wrappers must request this file directly. All other Project Instructions documents are loaded indirectly through the references below. |
| 8 | + |
| 9 | +## Current Version/Date |
| 10 | + |
| 11 | +- Project Instructions Version: 2026-06-28.PR_26179_OWNER_010 |
| 12 | +- Date: 2026-06-28 |
| 13 | +- Owner: OWNER |
| 14 | + |
| 15 | +## Required Read Order |
| 16 | + |
| 17 | +1. Always read `dev/build/ProjectInstructions/PROJECT_INSTRUCTIONS.md`. |
| 18 | +2. Always read `dev/build/ProjectInstructions/PROJECT_STATE.md`. |
| 19 | +3. Always read `dev/build/ProjectInstructions/repository/canonical_repository_structure.md`. |
| 20 | +4. For Codex workflow command interpretation, read `dev/build/ProjectInstructions/standards/CODEX_WORKFLOW_COMMANDS.md`. |
| 21 | +5. For Start of Day, read `dev/build/ProjectInstructions/bootstrap/codex_start_of_day_bootstrap.md`. |
| 22 | +6. Load team, backlog, database, runtime, theme, or other specialist documents only when the current task requires them. |
| 23 | + |
| 24 | +## Load Graph |
| 25 | + |
| 26 | +```text |
| 27 | +PROJECT_INSTRUCTIONS.md |
| 28 | +|-- PROJECT_STATE.md |
| 29 | +|-- repository/canonical_repository_structure.md |
| 30 | +|-- standards/CODEX_WORKFLOW_COMMANDS.md |
| 31 | +| `-- Start of Day, PLAN_PR, BUILD_PR, APPLY_PR, or command interpretation |
| 32 | +|-- bootstrap/codex_start_of_day_bootstrap.md |
| 33 | +| `-- Start of Day only |
| 34 | +|-- team/backlog docs |
| 35 | +| `-- Start of Day, planning, or team-specific PRs only |
| 36 | +|-- database docs |
| 37 | +| `-- DB, DDL, DML, seed, or API persistence changes only |
| 38 | +|-- runtime docs |
| 39 | +| `-- runtime, API, or service changes only |
| 40 | +`-- theme docs |
| 41 | + `-- UI, theme, or page changes only |
| 42 | +``` |
| 43 | + |
| 44 | +## When-To-Load Rules |
| 45 | + |
| 46 | +- `PROJECT_INSTRUCTIONS.md`: always. |
| 47 | +- `PROJECT_STATE.md`: always. |
| 48 | +- `repository/canonical_repository_structure.md`: always. |
| 49 | +- `standards/CODEX_WORKFLOW_COMMANDS.md`: Start of Day, PLAN_PR, BUILD_PR, APPLY_PR, invalid command, or command interpretation tasks. |
| 50 | +- `bootstrap/codex_start_of_day_bootstrap.md`: Start of Day only. |
| 51 | +- Backlog docs: Start of Day or planning only. |
| 52 | +- Database docs: DB, DDL, DML, seed, or API persistence changes only. |
| 53 | +- Runtime docs: runtime, API, or service changes only. |
| 54 | +- Theme docs: UI, theme, or page changes only. |
| 55 | +- Team docs: team-specific PRs only. |
| 56 | + |
| 57 | +## Stop Gates |
| 58 | + |
| 59 | +Stop before changing files when: |
| 60 | + |
| 61 | +- the current branch does not match the requested branch |
| 62 | +- the worktree is dirty and the request requires a clean start |
| 63 | +- the requested path does not fit `repository/canonical_repository_structure.md` |
| 64 | +- the request conflicts with active Project Instructions |
| 65 | +- the task would modify runtime code, production pages, database files, wrapper scripts, or repository folders outside the stated scope |
| 66 | +- a required source document is missing |
| 67 | +- validation fails |
| 68 | + |
| 69 | +## Execution Modes |
| 70 | + |
| 71 | +Official Codex workflow command governance lives in: |
| 72 | + |
| 73 | +`dev/build/ProjectInstructions/standards/CODEX_WORKFLOW_COMMANDS.md` |
| 74 | + |
| 75 | +That file owns Start of Day, PLAN_PR, BUILD_PR, APPLY_PR, and invalid command behavior. |
| 76 | + |
| 77 | +## Referenced Documents |
| 78 | + |
| 79 | +- Project state: `dev/build/ProjectInstructions/PROJECT_STATE.md` |
| 80 | +- Repository folder placement SSoT: `dev/build/ProjectInstructions/repository/canonical_repository_structure.md` |
| 81 | +- Codex workflow commands: `dev/build/ProjectInstructions/standards/CODEX_WORKFLOW_COMMANDS.md` |
| 82 | +- Codex Start-of-Day bootstrap: `dev/build/ProjectInstructions/bootstrap/codex_start_of_day_bootstrap.md` |
| 83 | +- Branch lifecycle: `dev/build/ProjectInstructions/addendums/project_instructions_single_source_eod_lock.md` |
| 84 | +- PR workflow: `dev/build/ProjectInstructions/addendums/pr_workflow.md` |
| 85 | +- Team ownership: `dev/build/ProjectInstructions/team_assignments/team_ownership.md` |
| 86 | +- Team assignments: `dev/build/ProjectInstructions/team_assignments/TEAM_ASSIGNMENTS.md` |
| 87 | +- Backlog: `dev/build/ProjectInstructions/backlog/BACKLOG_MASTER.md` |
| 88 | +- Database docs: `dev/build/database/` |
| 89 | +- Runtime/API standards: `dev/build/ProjectInstructions/standards/` |
| 90 | +- Runtime/API governance: `dev/build/ProjectInstructions/addendums/environment_governance_model.md` |
| 91 | +- Theme/UI governance: `dev/build/ProjectInstructions/addendums/table_first_ui.md` |
| 92 | +- Documentation ownership: `dev/build/ProjectInstructions/addendums/documentation_ownership.md` |
| 93 | +- Artifact/reporting standard: `dev/build/ProjectInstructions/addendums/codex_artifact_and_reporting_standard.md` |
| 94 | +- Environment governance: `dev/build/ProjectInstructions/addendums/environment_governance_model.md` |
| 95 | +- Environment configuration: `dev/build/ProjectInstructions/addendums/environment_configuration_standards.md` |
| 96 | +- Active standards: `dev/build/ProjectInstructions/standards/` |
| 97 | + |
| 98 | +## Single Source Of Truth Decisions |
| 99 | + |
| 100 | +- `PROJECT_INSTRUCTIONS.md` owns the manual entry point, required read order, load graph, stop gates, execution modes, and pointers. |
| 101 | +- `PROJECT_STATE.md` owns machine-friendly project state metadata. |
| 102 | +- `repository/canonical_repository_structure.md` owns all folder placement and file-placement rules. |
| 103 | +- `standards/CODEX_WORKFLOW_COMMANDS.md` owns Start of Day, PLAN_PR, BUILD_PR, APPLY_PR, and invalid command behavior. |
| 104 | +- `bootstrap/codex_start_of_day_bootstrap.md` owns Start-of-Day bootstrap architecture. |
| 105 | +- `addendums/codex_artifact_and_reporting_standard.md` owns the Codex Completion Contract and ZIP outcome rules. |
0 commit comments