sneak/smallwebwaf
1
0
Fork 0
Code Issues 5 Pull Requests 2 Actions 6 Packages Projects Releases Wiki Activity

Rewrite SPEC.md from scratch, short and plain #156

New Issue
Open
opened 2026-10-22 20:04:07 +02:00 by clawbot · 3 comments
clawbot commented 2026-10-22 20:04:07 +02:00
Collaborator
Copy Link
Copy Source

sneak, 22 October (chat): "it also needs to rewrite the smallwebwaf SPEC file bc that one is extremely over-verbose and rambly too."

What. Rewrite SPEC.md from scratch, short and direct, keeping every requirement it states. The current text is the reference for what the spec requires, not a text to edit. Where it is unclear or disagrees with the code, the difference is listed in the PR body rather than settled silently.

Definition of done.

  • Every requirement in the old SPEC.md is in the new one, said once, in plain words; nothing is added that the old one does not require.
  • A competent newcomer can read it once and know what smallwebwaf must do and why.
  • Plain words, no coined terms; identifiers in backticks; no markdown tables.
  • make fmt applied and script/cibuild green on the branch.
  • One PR into next, its title ending with (closes #N), N being this issue.

Model: opus-5-5

sneak, 22 October (chat): "it also needs to rewrite the smallwebwaf SPEC file bc that one is extremely over-verbose and rambly too." **What.** Rewrite `SPEC.md` from scratch, short and direct, keeping every requirement it states. The current text is the reference for what the spec requires, not a text to edit. Where it is unclear or disagrees with the code, the difference is listed in the PR body rather than settled silently. **Definition of done.** - Every requirement in the old `SPEC.md` is in the new one, said once, in plain words; nothing is added that the old one does not require. - A competent newcomer can read it once and know what smallwebwaf must do and why. - Plain words, no coined terms; identifiers in backticks; no markdown tables. - `make fmt` applied and `script/cibuild` green on the branch. - One PR into `next`, its title ending with (closes #N), N being this issue. Model: opus-5-5
sneak commented 2026-10-22 20:23:39 +02:00
Owner
Copy Link
Copy Source

separate current code reality from planned future work in different sections, please.

separate current code reality from planned future work in different sections, please.
clawbot commented 2026-10-22 20:35:36 +02:00
Author
Collaborator
Copy Link
Copy Source

Recorded and passed to the writer: the new SPEC.md has one section for what the code on next does today, and a separate section for planned work that is not built yet.

Model: opus-5-5

Recorded and passed to the writer: the new `SPEC.md` has one section for what the code on `next` does today, and a separate section for planned work that is not built yet. Model: opus-5-5
clawbot commented 2026-10-22 20:53:27 +02:00
Author
Collaborator
Copy Link
Copy Source

The rewrite is up for review as #159, into next, with the built behaviour in the main sections and a last section "Planned, not built"; make fmt applied and script/cibuild green. The PR body lists each point where the old spec disagreed with the code.

Model: fable-5-1

The rewrite is up for review as https://git.eeqj.de/sneak/smallwebwaf/pulls/159, into `next`, with the built behaviour in the main sections and a last section "Planned, not built"; `make fmt` applied and `script/cibuild` green. The PR body lists each point where the old spec disagreed with the code. Model: fable-5-1
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
critical
Extremely important: data loss, a security hole, production down, or basic use impossible
 merge-ready
Reviewed and ready for the owner to merge
 needs-checks
Checks must be fixed before review
 needs-rebase
Conflicts with next; rebase required
 needs-review
Review not yet done
 needs-rework
Review found issues to fix
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
clawbot sneak (Jeffrey Paul)
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/smallwebwaf#156