TODO.md narrates an agent-tooling directory by vendor name; scrub the prose #43

New Issue

clawbot · 2026-08-10T16:15:18+02:00

clawbot commented

2026-08-10 16:15:18 +02:00

Standing rule: no vendor tooling name appears anywhere in this repo's documentation or output.

Two lines in the TODO.md Completed Steps narrative describe an ignore-file entry by naming the vendor directory it refers to. They are prose about the change, not the change, and can be reworded to say what was ignored and why without naming the product.

Both lines are pre-existing, from commits already on main. Found during review of #41 and correctly left alone there as out of scope.

Recommendation, and the distinction that matters

Scrub the prose; keep the ignore-file entries.

In .gitignore and .dockerignore the string is load-bearing — it is the actual directory name on disk, and the entries exist so agent working directories are never committed or shipped into a build context. Removing them would reintroduce a real defect to satisfy a naming rule. A path that must match a real directory is functional configuration, not documentation.

In TODO.md it is narrative, matches nothing, and is straightforwardly rewritable.

Definition of done

The two TODO.md lines describe the exclusion without naming the vendor or product.
.gitignore and .dockerignore are unchanged, with a brief note recorded here confirming that was deliberate.
A sweep of the rest of the tree confirms no other prose occurrence survives; report the sweep, not just the conclusion.
make check green, make fmt run.

Note for whoever takes this

Do not quote the offending string into issue or PR comments while fixing it — that just relocates the problem onto the tracker. Refer to line numbers.

Standing rule: no vendor tooling name appears anywhere in this repo's documentation or output. Two lines in the `TODO.md` Completed Steps narrative describe an ignore-file entry by naming the vendor directory it refers to. They are prose about the change, not the change, and can be reworded to say what was ignored and why without naming the product. Both lines are pre-existing, from commits already on `main`. Found during review of https://git.eeqj.de/sneak/lora.vegas/pulls/41 and correctly left alone there as out of scope. ## Recommendation, and the distinction that matters Scrub the **prose**; keep the **ignore-file entries**. In `.gitignore` and `.dockerignore` the string is load-bearing — it is the actual directory name on disk, and the entries exist so agent working directories are never committed or shipped into a build context. Removing them would reintroduce a real defect to satisfy a naming rule. A path that must match a real directory is functional configuration, not documentation. In `TODO.md` it is narrative, matches nothing, and is straightforwardly rewritable. ## Definition of done - The two `TODO.md` lines describe the exclusion without naming the vendor or product. - `.gitignore` and `.dockerignore` are unchanged, with a brief note recorded here confirming that was deliberate. - A sweep of the rest of the tree confirms no other prose occurrence survives; report the sweep, not just the conclusion. - `make check` green, `make fmt` run. ## Note for whoever takes this Do not quote the offending string into issue or PR comments while fixing it — that just relocates the problem onto the tracker. Refer to line numbers.

clawbot referenced this issue

2026-08-10 16:15:43 +02:00

Prettier scope depends on .gitignore to stay out of dot-directories; make the exclusion explicit #33

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: sneak/lora.vegas#43