mirror of
https://github.com/jkdansereau/goldeneye-pc-port.git
synced 2026-10-24 00:02:45 +02:00
James Dansereau
1c60da6f46
Widens the written scope of AGENTS.md non-negotiable #2's ABI exception to match established practice (runtime struct/union misreads, not just ROM-serialized structs — the D209/D210/D255 pattern), states explicitly that diagnosis into src/game is never restricted (only the fix is), and defines a real three-bucket taxonomy + sign-off procedure (dev-process.md §7) for the rare genuine-behavior-difference case, replacing the undefined ad hoc "ask the user" gesture that's been referenced without being defined across ~10 places in the docs. Mirrors the same framing into CONTRIBUTING.md and the PR template for external contributors. Extends porting-notes.md §A1 with D255 as a third worked example and a tell-tale-signs checklist, explicitly distinguishing it from D284 (same epistemic shape, different mechanism, no rule-2 question at all). Appends a ready-to-dispatch pass-10 brief to the D236 entry applying the new taxonomy to its actual next step. Docs-only; no code/build changes. Per docs/dev/notes/RULE-2-CLARIFICATION-PLAN.md.
43 lines
1.5 KiB
Markdown
43 lines
1.5 KiB
Markdown
<!--
|
|
Read CONTRIBUTING.md first. This is a faithfulness-focused port; the ground
|
|
rules there are non-negotiable.
|
|
-->
|
|
|
|
## What this changes
|
|
|
|
<!-- One or two sentences. Link the issue it closes: "Closes #123". -->
|
|
|
|
## Why
|
|
|
|
<!-- The reasoning, not just the diff. What was wrong / missing? -->
|
|
|
|
## Scope check
|
|
|
|
- [ ] No changes under `src/` or `include/` — **or** the only changes are
|
|
the narrow `#ifdef PORT` ABI exception (CONTRIBUTING.md rule 2),
|
|
checked against `docs/porting-notes.md` §A1, and documented in
|
|
`docs/dev/findings.md` (§F/D3x).
|
|
- [ ] If this PR contains a genuine `src/game` behavior change (not an
|
|
ABI/layout fix): an explicit rule-2 sign-off was granted
|
|
(`docs/dev-process.md` §7) and is recorded in a
|
|
`RULE-2-SIGNOFF`-tagged `docs/dev/findings.md` entry linked here.
|
|
- [ ] `Makefile`, `tools/`, `rsp/`, `ld/` untouched (N64 build).
|
|
- [ ] If `CMakeLists.txt` `REGION_DEFS` changed, it still matches the N64
|
|
`Makefile` per-region macro set exactly.
|
|
|
|
## Verification
|
|
|
|
<!-- What you actually ran. Delete lines that don't apply. -->
|
|
|
|
- [ ] `./build-pc.sh ntsc-final` — clean configure + link
|
|
- [ ] Crash-free run of at least one level (`-level_09`)
|
|
- [ ] Single-frame `GE_PCDUMP` diff against the committed golden — no
|
|
unexpected change
|
|
- [ ] pal-final / jpn-final also configured
|
|
|
|
Platform tested: <!-- e.g. Windows 10 / MSYS2 MINGW64 -->
|
|
|
|
## Notes for the reviewer
|
|
|
|
<!-- Anything uncertain, follow-ups, or areas that need a closer look. -->
|