Skip to content

Commit 79bdee2

Browse files
docs: record tech-debt audit findings (2026-05-26) (#198)
## Summary - Adds `docs/tech-debt-2026-05-26.md` with this repo's findings. ## Companion audits - #195 — proof-debt - #196 — licence-debt - #197 — documentation-debt Records findings only. Closing debt is follow-up. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 66c61ee commit 79bdee2

1 file changed

Lines changed: 74 additions & 0 deletions

File tree

docs/tech-debt-2026-05-26.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<!--
2+
SPDX-License-Identifier: MPL-2.0
3+
SPDX-FileCopyrightText: 2026 Jonathan D.A. Jewell (hyperpolymath)
4+
-->
5+
6+
# Tech-Debt Audit — standards — 2026-05-26
7+
8+
**Source:** estate-wide automated scan 2026-05-26.
9+
**Companion:** [`hyperpolymath/standards` 2026-05-26-estate-*-debt audits](https://github.com/hyperpolymath/standards/tree/main/docs/audits).
10+
**Combined severity:** `HIGH`.
11+
12+
This file records the *raw findings* — it does not by itself fix the debt. Each section ends with a 'Recommended next move' line; closing the debt is follow-up work.
13+
14+
## 1. Proof debt
15+
16+
Scanner counted the following markers in proof-bearing files of this repo:
17+
18+
```
19+
files= 34 | Coq-Axm/Adm= 0 | Lean-srry/ax= 0 | Agda-pst= 4 | Idr-blv= 1 | Idr-prtl= 11 | Fstr-asm= 0 | TODO= 0 | Unsafe= 0
20+
```
21+
22+
**Total markers:** 16. **Severity:** `>016`.
23+
24+
**Marker types** (any non-zero counts above):
25+
- Coq `Axiom`/`Admitted` — unconditional proof escapes.
26+
- Lean `sorry`/`axiom` — Lean's equivalent.
27+
- Agda `postulate` — accepted axiomatically.
28+
- Idris2 `believe_me`/`assert_total` — runtime-safe coercion / totality assumption.
29+
- Idris2 top-level `partial` — totality-check waived.
30+
- F\* `assume val`/`admit_p` — F\* admit.
31+
- `TODO PROOF` / `OWED:` — self-documented debt markers.
32+
- `unsafePerformIO`/`unsafeCoerce` — soundness-relevant escape hatches in Haskell/Rust source.
33+
34+
**Recommended next move:** triage each finding into one of: (a) discharge by proof, (b) cover with property-tests + a documented refutation budget, or (c) annotate as a known/necessary axiom (e.g. `funExt`) in `docs/proof-debt.md`.
35+
36+
## 2. Licence debt
37+
38+
| Field | Value |
39+
|---|---|
40+
| LICENSE file | `LICENSE` |
41+
| SPDX header | `MPL-2.0` |
42+
| Manifest licence | `NONE` |
43+
| Body classifier | `PMPL-1.0-or-later` |
44+
| Severity | `HIGH-mismatch` |
45+
| Notes | `SPDX=MPL-2.0_but_body=PMPL` |
46+
47+
**Recommended next move:** the SPDX header says `MPL-2.0` but the licence body still uses Palimpsest/PMPL language. Per estate policy (memory: `feedback_estate_lang_policy_2026_05_25`) the migration target is MPL-2.0. Replace the LICENSE body with the canonical MPL-2.0 text (keep SPDX header; can keep a small Palimpsest preamble as commentary).
48+
49+
## 3. Documentation debt
50+
51+
| Field | Value |
52+
|---|---|
53+
| README lines | 436 |
54+
| `docs/` files | 321 |
55+
| `docs/` LoC | 22993 |
56+
| CHANGELOG.md | N |
57+
| CONTRIBUTING.md | Y |
58+
| CODE_OF_CONDUCT.md | Y |
59+
| SECURITY.md | Y |
60+
| Severity | `OK` |
61+
62+
**Recommended next move:** none for docs.
63+
64+
Additionally: **CHANGELOG.md is missing.** 65% of estate repos lack one — adopting a CHANGELOG (or auto-generating via `git-cliff`) is a recommended estate-wide follow-up.
65+
66+
## Cross-references
67+
68+
- Estate proof-debt audit: `hyperpolymath/standards/docs/audits/2026-05-26-estate-proof-debt.md`
69+
- Estate licence-debt audit: `hyperpolymath/standards/docs/audits/2026-05-26-estate-licence-debt.md`
70+
- Estate documentation-debt audit: `hyperpolymath/standards/docs/audits/2026-05-26-estate-documentation-debt.md`
71+
72+
---
73+
74+
🤖 Generated by Claude Code estate-wide tech-debt scan (2026-05-26). This file is informational — closing the debt is follow-up work owned by the maintainer.

0 commit comments

Comments
 (0)