Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .github/codex/prompts/pr_review.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ When reviewing new features or code paths, specifically check:

## Deferred Work Acceptance

This project tracks deferred technical debt in `TODO.md` under "Tech Debt from Code Reviews."
This project tracks deferred technical debt in `TODO.md` under "Deferred / Documented"
(blocked items, sub-grouped by blocker) and shippable items under "Actionable Backlog."

- If a limitation is already tracked in `TODO.md` with a PR reference, it is NOT a blocker.
- If a PR ADDS a new `TODO.md` entry for deferred work, that counts as properly tracking
Expand Down Expand Up @@ -96,7 +97,7 @@ Apply the assessment based on the HIGHEST severity of UNMITIGATED findings:

A finding is MITIGATED (does not count toward assessment) if:
- The deviation is documented in `docs/methodology/REGISTRY.md` with a Note/Deviation label
- The limitation is tracked in `TODO.md` under "Tech Debt from Code Reviews"
- The limitation is tracked in `TODO.md` under "Deferred / Documented" or "Actionable Backlog"
- The PR itself adds a TODO.md entry or REGISTRY.md note for the issue
- The finding is about an implementation choice between valid numerical approaches

Expand Down
19 changes: 17 additions & 2 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,23 @@ wording will cause a P1 finding ("undocumented methodology deviation").

**TODO.md format** — for deferring P2/P3 items only (P0/P1 cannot be deferred):

Add a row to the table in `TODO.md` under "Tech Debt from Code Reviews" in the appropriate
category (`Methodology/Correctness`, `Performance`, or `Testing/Docs`):
Add a row to `TODO.md`. If the item is genuinely shippable (clear path, no external
blocker), put it under **Actionable Backlog** in the appropriate sub-section
(`Methodology / correctness`, `Performance`, or `Testing / docs`). If it is blocked, put it
under **Deferred / Documented** in the matching blocker sub-section (`Paper-gated / needs
methodology derivation`, `Needs external reference (R / Stata / Julia)`, `Parked — pending
user demand / out of scope`, or `Won't-fix / waived`). Either way the AI reviewer's
deviation-grep resolves on the row's `Location` + reason text. The two buckets use
different table shapes — Actionable rows carry an `Effort` column, Deferred rows a `PR`
column:

Actionable Backlog:

| Issue | Location | Origin | Effort | Priority |
|-------|----------|--------|--------|----------|
| Description of the work item | `file.py` | #NNN | Quick/Mid/Heavy | Medium/Low |

Deferred / Documented:

| Issue | Location | PR | Priority |
|-------|----------|----|----------|
Expand Down
Loading
Loading