|
| 1 | +# BUILD_PR_ENGINE_IMPORT_BASELINE_AND_CONTRACT |
| 2 | + |
| 3 | +## PR Purpose |
| 4 | +Create one execution-ready, low-token lane to baseline current `/src/engine/` usage and convert it into an explicit contract report. |
| 5 | + |
| 6 | +## Scope |
| 7 | +This PR is single-purpose: |
| 8 | +- inventory current `/src/engine/` imports and stylesheet references |
| 9 | +- classify the usage surface by area |
| 10 | +- record whether the current import style is already stable enough to treat as the baseline contract |
| 11 | +- do not rewrite imports in this PR |
| 12 | +- do not move files |
| 13 | +- do not touch unrelated cleanup targets |
| 14 | + |
| 15 | +## Why This PR Now |
| 16 | +Recent cleanup work reduced noise and removed active template blockers. This makes engine import baselining a good next high-impact lane with low execution risk. |
| 17 | + |
| 18 | +## Exact Target Files |
| 19 | + |
| 20 | +### Must create or overwrite |
| 21 | +- `docs/dev/reports/engine_import_baseline_report.md` |
| 22 | +- `docs/dev/reports/engine_import_contract_decision.md` |
| 23 | +- `docs/dev/reports/BUILD_PR_ENGINE_IMPORT_BASELINE_AND_CONTRACT_report.md` |
| 24 | +- `docs/dev/reports/validation_checklist.txt` |
| 25 | + |
| 26 | +### May update only if already present and only to align with this PR |
| 27 | +- `docs/dev/roadmaps/MASTER_ROADMAP_HIGH_LEVEL.md` |
| 28 | + |
| 29 | +## Required Work |
| 30 | + |
| 31 | +### 1) Baseline report |
| 32 | +Create `docs/dev/reports/engine_import_baseline_report.md`. |
| 33 | + |
| 34 | +This report must: |
| 35 | +- summarize current `/src/engine/` usage in active repo surfaces |
| 36 | +- separate usage into: |
| 37 | + - `src/` |
| 38 | + - `games/` |
| 39 | + - `samples/` |
| 40 | + - `tools/` |
| 41 | + - HTML stylesheet references |
| 42 | + - metadata/report-only references if found |
| 43 | +- identify whether current usage appears consistent, mixed, or transitional |
| 44 | +- capture exact validation commands used |
| 45 | + |
| 46 | +### 2) Contract decision |
| 47 | +Create `docs/dev/reports/engine_import_contract_decision.md`. |
| 48 | + |
| 49 | +This file must include: |
| 50 | +- current contract candidate: |
| 51 | + - `absolute-root /src/engine/*` |
| 52 | +- whether this should be treated as the current baseline contract |
| 53 | +- rationale |
| 54 | +- allowed now |
| 55 | +- not allowed now |
| 56 | +- exact future follow-up needed before any mass rewrite lane |
| 57 | + |
| 58 | +Expected outcome for this PR: |
| 59 | +- treat the current `/src/engine/` style as the active baseline unless contradictory evidence is found |
| 60 | + |
| 61 | +### 3) Optional roadmap alignment |
| 62 | +Only if exact wording already exists, Codex may apply bracket-only roadmap state updates for: |
| 63 | +- `imports normalized after moves` |
| 64 | +- `imports pointing to legacy paths reduced` |
| 65 | +- `move/refactor validation strategy documented` |
| 66 | + |
| 67 | +Rules: |
| 68 | +- no wording edits |
| 69 | +- no reorder |
| 70 | +- if exact text is not cleanly applicable, record it in the BUILD report under `Unapplied Planned Delta` |
| 71 | + |
| 72 | +### 4) BUILD report |
| 73 | +Create `docs/dev/reports/BUILD_PR_ENGINE_IMPORT_BASELINE_AND_CONTRACT_report.md` with: |
| 74 | +- bundle type |
| 75 | +- exact files created |
| 76 | +- exact files changed |
| 77 | +- summary of findings |
| 78 | +- contract decision |
| 79 | +- any roadmap bracket changes actually applied |
| 80 | +- unapplied delta if any |
| 81 | +- explicit statement that no runtime code, file moves, or import rewrites occurred |
| 82 | + |
| 83 | +### 5) Validation checklist |
| 84 | +Create `docs/dev/reports/validation_checklist.txt` with pass/fail for: |
| 85 | +- protected start_of_day directories untouched |
| 86 | +- no runtime import rewrites performed |
| 87 | +- required reports created |
| 88 | +- roadmap wording preserved if roadmap changed |
| 89 | +- roadmap changes bracket-only if roadmap changed |
| 90 | + |
| 91 | +## Validation Commands Codex Must Run |
| 92 | +Run only narrow commands needed for this PR: |
| 93 | +1. scan active repo surfaces for `/src/engine/` |
| 94 | +2. scan HTML files for `/src/engine/ui/` |
| 95 | +3. confirm no changes under protected start_of_day directories |
| 96 | +4. if roadmap changed, verify diff is bracket-only |
| 97 | + |
| 98 | +## Non-Goals |
| 99 | +- no import rewrites |
| 100 | +- no directory moves |
| 101 | +- no broad cleanup |
| 102 | +- no template/archive work |
| 103 | +- no runtime behavior changes |
| 104 | + |
| 105 | +## Expected Output |
| 106 | +Package output to: |
| 107 | +- `<project folder>/tmp/BUILD_PR_ENGINE_IMPORT_BASELINE_AND_CONTRACT.zip` |
0 commit comments