Skip to content

docs(DOC-004): record the September 2026 tech-debt audit - #118

Open
DoRmAmMu1997 wants to merge 4 commits into
mainfrom
docs/doc-004-audit-register-2026-09
Open

docs(DOC-004): record the September 2026 tech-debt audit#118
DoRmAmMu1997 wants to merge 4 commits into
mainfrom
docs/doc-004-audit-register-2026-09

Conversation

@DoRmAmMu1997

@DoRmAmMu1997 DoRmAmMu1997 commented Sep 4, 2026

Copy link
Copy Markdown
Owner

Appends a dated section to the audit register covering a tech-debt sweep of main @ 2833bcf.

Verdict

The codebase is in good shape. Zero TODO/FIXME/HACK markers in application code, no coverage omit list hiding anything from the 89% floor, three skipped tests (two of them UPDATE_GOLDEN guards), no xfail/skipif anywhere, 28 modern dependency pins with nothing a major version behind, consistent 3.11 targeting across Dockerfile / ruff / mypy / CI, and 44,968 lines of application code against 37,754 lines of tests.

The register itself is working: it steered this pass away from three dead ends.

What the section records

  • Fixed in this pass — DEPLOY-005 (fix(DEPLOY-005): resolve pinned universe sources from the repo, not DATA_DIR #116) and QUAL-008 (fix(QUAL-008): pin the pre-commit ruff hook to the version CI installs #117), with the DEPLOY-005 defect written up in full including the honest caveat that Docker is unavailable locally, so container-level verification was not performed.
  • Twelve open findings, ranked by the (Impact + Risk) x (6 - Effort) model, each with file:line evidence. Top of the list: silent universe erosion, app.py sitting outside the coverage gate, pytest shipping in the production image, and the score-resolution guard asymmetry between comparison.py and repository.py.
  • Local environment drift — the dev machine runs Python 3.13.13 / numpy 2.5.2 against pinned 3.11–3.12 / numpy 2.4.6, which currently breaks python -m mypy and pre-commit run --all-files. Both were reproduced on untouched main, so they are recorded as environment facts, not repo debt.
  • One finding verified FALSE — the "deferred scan_results(symbol, signal_date) composite index" was actually shipped by VALID-001 (models.py:274, the VALID-001 migration, and the drift guard at test_scan_storage_migrations.py:147). The "deferred to VALID-*" lines in the design docs are historical notes, not open work.

On not re-flagging settled decisions

Every finding was checked against the June and July sections before being written down. Two entries say so explicitly, because they sit next to prior decisions:

  • The IPO SDK-runner gap is recorded as new information about a runner added after the boilerplate-dedup ADR — measurably, its _default_run has 0 of the is_error / CLINotFoundError / ProcessError / usage-limit handling its three siblings carry — and not as a re-proposal of the refactor that ADR rejected.
  • The backend/ipo/repository.py naming smell is recorded together with the check confirming it is not an AGENTS.md §4 violation.

Verification

Docs-only change. pytest -q --cov=... --cov-fail-under=89 — 2034 passed, 1 skipped, 89.97%; ruff check clean; origin/main merged in and gates re-run after PRs #112/#114 landed.

🤖 Generated with Claude Code

DoRmAmMu1997 and others added 3 commits September 4, 2026 19:15
Appends a dated section to the audit register covering a sweep of main @ 2833bcf:
the two items fixed (DEPLOY-005, QUAL-008), twelve ranked open findings with
file:line evidence, the local environment drift that currently blocks the mypy
and pre-commit gates on this machine, and one claim verified false.

Follows the register's established discipline. Every finding was checked against
the June and July sections before being written down, so nothing already closed,
rejected by ADR, or previously verified false is re-flagged. Two entries say so
explicitly, because they sit next to prior decisions: the IPO SDK-runner gap is
recorded as new information about a runner added after the boilerplate-dedup ADR
rather than a re-proposal of it, and the ipo/repository.py naming smell is
recorded together with the check that confirmed it is not an AGENTS.md section 4
violation.

The verified-false entry is the deferred scan_results(symbol, signal_date)
composite index, which VALID-001 actually shipped -- the "deferred to VALID-*"
lines in the design docs are historical notes, not open work.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Matches how the June and July waves record their work.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
OBS-004 (#119/#124), QUAL-009 (#120/#123) and SEC-004 (#121/#122) were filed and
built immediately after the audit, so the register should not describe them as
untouched. The remaining entries stay as recorded findings.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant