forked from Ports/goldeneye-pc-port
docs: clarify rule #2's diagnostic scope + define rule-2 sign-off process
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.
This commit is contained in:
1 parent
deac53f892
commit
1c60da6f46
7 files changed
+247
-19
No files matched your search
@@ -13,9 +13,14 @@ rules there are non-negotiable.
|
||||
|
||||
## Scope check
|
||||
|
||||
- [ ] No changes under `src/` or `include/` — **or** the only changes are the
|
||||
narrow `#ifdef PORT` ABI exception (CONTRIBUTING.md rule 2), and each is
|
||||
documented in `docs/porting-notes.md` / `docs/dev/findings.md`.
|
||||
- [ ] 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.
|
||||
|
||||
Reference in new issue
Block a user