Cut the narration from TODO.md entries and script/Dockerfile comment blocks #49

Closed
opened 2026-08-10 15:46:09 +02:00 by clawbot · 3 comments
Collaborator

Owner instruction, sneak 2026-08-10: never be verbose in commit, issue
or PR prose, and the same applies to explanatory comments in code and
config — keep what a reader needs in order to avoid a trap, delete the
reasoning, the history and the self-justification.

This repo diverges badly. Several TODO.md Completed Steps entries run
40-80 lines and re-argue decisions already settled on the tracker;
script/bootstrap, script/cibuild, script/docker, Dockerfile and
Dockerfile.lint carry comment blocks longer than the code they
explain, much of it narrating why an earlier approach was rejected.

Definition of done

  • Each TODO.md Completed Steps entry states what landed, the
    non-obvious traps, and the evidence. History and rationale that the
    issue already carries goes; link the issue instead.
  • Comment blocks in script/ and both Dockerfiles keep the trap and
    drop the argument. A comment that exists to justify a past decision
    is deleted.
  • What must NOT be cut: any trap a reader would otherwise fall into,
    any disclosure (a deviation taken, a rule suppressed, a partially
    verified claim), and any recorded evidence that a check really ran.
    This is a cut of narration, not of content.
  • No behaviour change; make check green.
Owner instruction, sneak 2026-08-10: never be verbose in commit, issue or PR prose, and the same applies to explanatory comments in code and config — keep what a reader needs in order to avoid a trap, delete the reasoning, the history and the self-justification. This repo diverges badly. Several `TODO.md` Completed Steps entries run 40-80 lines and re-argue decisions already settled on the tracker; `script/bootstrap`, `script/cibuild`, `script/docker`, `Dockerfile` and `Dockerfile.lint` carry comment blocks longer than the code they explain, much of it narrating why an earlier approach was rejected. ## Definition of done - Each `TODO.md` Completed Steps entry states what landed, the non-obvious traps, and the evidence. History and rationale that the issue already carries goes; link the issue instead. - Comment blocks in `script/` and both Dockerfiles keep the trap and drop the argument. A comment that exists to justify a past decision is deleted. - What must NOT be cut: any trap a reader would otherwise fall into, any disclosure (a deviation taken, a rule suppressed, a partially verified claim), and any recorded evidence that a check really ran. This is a cut of narration, not of content. - No behaviour change; `make check` green.
clawbot added this to the 1.0.0 milestone 2026-08-10 15:46:14 +02:00
Author
Collaborator

Added to scope: TODO.md §Workflow still says to branch from main
and merge to main. Work now branches from next, PRs target next,
and only the owner merges next to main. Correct those lines in the
same change.

Sequenced last in the milestone: it rewrites comment blocks in
script/, Dockerfile and Dockerfile.lint, which
#39,
#43 and
#48 also change.

Model: fable-5-1

Added to scope: `TODO.md` §Workflow still says to branch from `main` and merge to `main`. Work now branches from `next`, PRs target `next`, and only the owner merges `next` to `main`. Correct those lines in the same change. Sequenced last in the milestone: it rewrites comment blocks in `script/`, `Dockerfile` and `Dockerfile.lint`, which https://git.eeqj.de/sneak/sfdupes/issues/39, https://git.eeqj.de/sneak/sfdupes/issues/43 and https://git.eeqj.de/sneak/sfdupes/issues/48 also change. Model: fable-5-1
Author
Collaborator

Plan (implementer's brief). Everything that touches these files has landed, so this goes now, as the last unit.

  • TODO.md Completed Steps: each entry keeps what landed, the trap a reader would fall into, and the issue link; the argument and history go (the issue carries them). Keep every disclosure and every record that a check actually ran, in one line each.
  • TODO.md §Workflow (comment above): work branches from next, PRs target next, an independent review gates each merge to next, and only the owner merges next to main.
  • Comment blocks in script/, Dockerfile, Dockerfile.lint: keep the trap, drop the justification. A comment that only defends a past decision is deleted.
  • No behaviour change: diff only comments and Markdown. make fmt for the Markdown; make check and script/cibuild (wrapped in timeout -s INT 900 inside flock -w 3600 /srv/code/tmp/docker-gate.lock, image removed) must pass.
  • PR body: what kinds of text were cut, and anything you kept on purpose that a reader might expect to see cut.

Model: opus-5-5

Plan (implementer's brief). Everything that touches these files has landed, so this goes now, as the last unit. - `TODO.md` Completed Steps: each entry keeps what landed, the trap a reader would fall into, and the issue link; the argument and history go (the issue carries them). Keep every disclosure and every record that a check actually ran, in one line each. - `TODO.md` §Workflow (comment above): work branches from `next`, PRs target `next`, an independent review gates each merge to `next`, and only the owner merges `next` to `main`. - Comment blocks in `script/`, `Dockerfile`, `Dockerfile.lint`: keep the trap, drop the justification. A comment that only defends a past decision is deleted. - No behaviour change: diff only comments and Markdown. `make fmt` for the Markdown; `make check` and `script/cibuild` (wrapped in `timeout -s INT 900` inside `flock -w 3600 /srv/code/tmp/docker-gate.lock`, image removed) must pass. - PR body: what kinds of text were cut, and anything you kept on purpose that a reader might expect to see cut. Model: opus-5-5
clawbot self-assigned this 2026-10-04 20:01:41 +02:00
Author
Collaborator

Implemented in #94: narration cut from TODO.md Completed Steps and from the comments in script/, Dockerfile and Dockerfile.lint; TODO.md §Workflow now targets next. The PR body lists what was kept on purpose.

Model: opus-5-5

Implemented in https://git.eeqj.de/sneak/sfdupes/pulls/94: narration cut from `TODO.md` Completed Steps and from the comments in `script/`, `Dockerfile` and `Dockerfile.lint`; `TODO.md` §Workflow now targets `next`. The PR body lists what was kept on purpose. Model: opus-5-5
Sign in to join this conversation.