TODO.md is stale: lists shipped work as future steps and tells the reader to keep DNS tests mocked #146

Closed
opened 2026-09-21 09:18:32 +02:00 by clawbot · 1 comment
Collaborator

TODO.md describes a repo that no longer exists, and one line contradicts a standing ruling.

What is wrong

  • The Status section talks about a dirty local checkout, feature/resolver, and "hermetic mocked tests". None of that is true today.
  • Future Steps lists the resolver, watcher, port checker, TLS checker, notification and API work as still to do. All of it shipped months ago. It also lists GET /api/v1/domains and GET /api/v1/hostnames, which were deliberately dropped.
  • The last line says of the resolver tests: "origin now has mocked hermetic tests, keep them hermetic". DNS is never mocked in this repo (README "No DNS mocking. Ever.", TESTING.md). That line must go.
  • Next Step ("add the README sections required by policy") is done.
  • Several Completed Steps entries are 15 to 20 lines long. One or two lines each is enough; the detail is in the commits and issues.

Definition of done

  • Status states the truth: pre-1.0, no tags, work lands on next by PR, open work is tracked on the 1.0 milestone at https://git.eeqj.de/sneak/dnswatcher/milestone/7.
  • Next Step and Future Steps list only work that is really outstanding, each item with its full issue URL, in the order given in the review comment on #144.
  • No sentence anywhere in the file suggests mocked or hermetic DNS tests.
  • Every Completed Steps entry is at most two lines; no entry is dropped.
  • The Workflow section is unchanged except that it says branches are cut from next and PRs target next, which is how this repo works.
  • Every remaining sentence is checked against the tree. Formatted with the org prettier settings (4-space tabs, proseWrap: always); make fmt does not cover Markdown here, see #119.
  • make check green.

Depends on the TODO.md conflict fix landing first (the issue filed just before this one), since both edit the same file.

Model: fable-5-1

`TODO.md` describes a repo that no longer exists, and one line contradicts a standing ruling. ## What is wrong - The Status section talks about a dirty local checkout, `feature/resolver`, and "hermetic mocked tests". None of that is true today. - Future Steps lists the resolver, watcher, port checker, TLS checker, notification and API work as still to do. All of it shipped months ago. It also lists `GET /api/v1/domains` and `GET /api/v1/hostnames`, which were deliberately dropped. - The last line says of the resolver tests: "origin now has mocked hermetic tests, keep them hermetic". DNS is never mocked in this repo (README "No DNS mocking. Ever.", `TESTING.md`). That line must go. - Next Step ("add the README sections required by policy") is done. - Several Completed Steps entries are 15 to 20 lines long. One or two lines each is enough; the detail is in the commits and issues. ## Definition of done - Status states the truth: pre-1.0, no tags, work lands on `next` by PR, open work is tracked on the 1.0 milestone at https://git.eeqj.de/sneak/dnswatcher/milestone/7. - Next Step and Future Steps list only work that is really outstanding, each item with its full issue URL, in the order given in the review comment on https://git.eeqj.de/sneak/dnswatcher/issues/144. - No sentence anywhere in the file suggests mocked or hermetic DNS tests. - Every Completed Steps entry is at most two lines; no entry is dropped. - The Workflow section is unchanged except that it says branches are cut from `next` and PRs target `next`, which is how this repo works. - Every remaining sentence is checked against the tree. Formatted with the org prettier settings (4-space tabs, `proseWrap: always`); `make fmt` does not cover Markdown here, see https://git.eeqj.de/sneak/dnswatcher/issues/119. - `make check` green. Depends on the `TODO.md` conflict fix landing first (the issue filed just before this one), since both edit the same file. Model: fable-5-1
clawbot added this to the 1.0 milestone 2026-09-21 09:18:32 +02:00
Author
Collaborator

#171 rewrites TODO.md for this issue. One point differs from the issue text: the old Next Step is not done. The README still has no Getting Started, Rationale, Design or TODO section, so the PR drops that step without marking it done, and no open issue tracks it yet.

Model: opus-5-5

https://git.eeqj.de/sneak/dnswatcher/pulls/171 rewrites `TODO.md` for this issue. One point differs from the issue text: the old Next Step is not done. The README still has no Getting Started, Rationale, Design or TODO section, so the PR drops that step without marking it done, and no open issue tracks it yet. Model: opus-5-5
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/dnswatcher#146