Commit bdd5a98
committed
docs: split into HISTORY (past) / PLAN (future) / LEARNINGS (lessons)
Rename CHANGELOG.md -> HISTORY.md and add two new docs:
- HISTORY.md (renamed from CHANGELOG.md, with framing rewritten as a
historical record rather than a changelog). Updated test counts
to current state (585 tests = 557 unit + 28 live), added the 6
batched/nested live tests to the catalog.
- PLAN.md (new): forward-looking roadmap. Confirmed gaps vs. upstream
internxt/cli (trash lifecycle is the only must-fix), potential
differentiators (folder copy, quota — neither side has them, easy
win), maintenance debt (drive.py too big, stale-cache audit,
pre-commit hooks). Workspaces explicitly skipped per user feedback
(out of scope, personal accounts only). Includes a substantial
WebDAV-providers reliability test plan addressing the field reports
of intermittent issues — outline of an in-process server fixture
with parameterized waitress vs cheroot coverage; the biggest
real-world blind spot we have today.
- LEARNINGS.md (new): retrospective. What each audit tool actually
catches (with examples — pylint's no-name-in-module flagged the
PROPPATCH ImportError that no other tool caught), why unit tests
miss certain bugs (3 concrete examples — cache coherency, /users/me
404, fuzzy-search semantics), the trust-roots-at-100% policy,
workarounds for testing wsgidav (construct via __new__, inject fake
submodules via sys.modules), live-test safety patterns (sentinel
folder, per-call UUIDs, .env gitignore audit), rate-limit /
eventual-consistency mitigation via pytest-rerunfailures,
crypto-compatibility annotation pattern (#nosec WITH reason), the
code-smell-to-bug correlation (5 separate "minor cleanup" findings
hiding real bugs), mypy union-attr vs assignment value calibration,
what to do differently next time.
readme.md: updated documentation index to point at the three new docs.1 parent 21f4057 commit bdd5a98
4 files changed
Lines changed: 700 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
4 | 10 | | |
5 | 11 | | |
6 | 12 | | |
7 | | - | |
8 | | - | |
| 13 | + | |
| 14 | + | |
9 | 15 | | |
10 | 16 | | |
11 | | - | |
| 17 | + | |
| 18 | + | |
12 | 19 | | |
13 | 20 | | |
14 | 21 | | |
| |||
271 | 278 | | |
272 | 279 | | |
273 | 280 | | |
274 | | - | |
| 281 | + | |
275 | 282 | | |
276 | 283 | | |
277 | 284 | | |
| |||
302 | 309 | | |
303 | 310 | | |
304 | 311 | | |
| 312 | + | |
305 | 313 | | |
306 | 314 | | |
307 | 315 | | |
| |||
317 | 325 | | |
318 | 326 | | |
319 | 327 | | |
320 | | - | |
321 | | - | |
| 328 | + | |
| 329 | + | |
| 330 | + | |
322 | 331 | | |
323 | 332 | | |
324 | 333 | | |
| |||
0 commit comments