Add AGENTS.md with the repository's rules for agents (closes #246) #247

Merged
clawbot merged 1 commits from issue-246-agents-md into next 2026-11-09 20:43:18 +01:00
Collaborator

Adds a root AGENTS.md with the branching model, the entrypoints, the editing rule, and two iron rules:

  • the request log keeps query strings as received;
  • the trusted-proxy default is the RFC 1918 set.

README.md links it under Documents. SPEC.md step 2, "The client is identified", now gives the default of SWRP_TRUSTED_PROXIES and says a list given replaces it, matching internal/config and docs/settings.md.

Closes #246

Model: opus-5-5

Adds a root `AGENTS.md` with the branching model, the entrypoints, the editing rule, and two iron rules: - the request log keeps query strings as received; - the trusted-proxy default is the RFC 1918 set. `README.md` links it under Documents. `SPEC.md` step 2, "The client is identified", now gives the default of `SWRP_TRUSTED_PROXIES` and says a list given replaces it, matching `internal/config` and `docs/settings.md`. Closes https://git.eeqj.de/sneak/smallwebwaf/issues/246 Model: opus-5-5
clawbot self-assigned this 2026-11-09 19:16:17 +01:00
clawbot added the needs-review label 2026-11-09 19:16:24 +01:00
Author
Collaborator

FAIL (needs-rework).

  1. AGENTS.md lines 10–11, "Each issue lands on next as one squashed commit whose title ends (closes #N).", is false for one landing shape. A PR of exactly two commits, the first adding tests that fail against the current code and the second the fix with no test assertion changed, is rebase-merged with both commits kept. A manager following this line would squash such a PR and lose the commit that shows the tests failing. Acceptable: keep the sentence and add one short sentence after it saying that this shape lands as its two commits.
  2. AGENTS.md lines 31–36, Iron rules: the trusted-proxy rule is split over two top-level bullets. The second starts with "SPEC.md states that default.", a fact about a document, and then gives an unrelated rule. The list reads as three iron rules where the issue has two. Acceptable: one top-level bullet for the trusted-proxy default, with the three netblocks, the SPEC.md sentence and "Forwarded headers count only when the peer is a trusted proxy." nested under it.

Judgement call: finding 1 departs from the wording of the issue's definition of done. That wording came from the issue, not from sneak, and the standing rule for two-commit PRs whose first commit adds failing tests takes precedence.

Model: opus-5-5

FAIL (`needs-rework`). 1. `AGENTS.md` lines 10–11, "Each issue lands on `next` as one squashed commit whose title ends ` (closes #N)`.", is false for one landing shape. A PR of exactly two commits, the first adding tests that fail against the current code and the second the fix with no test assertion changed, is rebase-merged with both commits kept. A manager following this line would squash such a PR and lose the commit that shows the tests failing. Acceptable: keep the sentence and add one short sentence after it saying that this shape lands as its two commits. 2. `AGENTS.md` lines 31–36, Iron rules: the trusted-proxy rule is split over two top-level bullets. The second starts with "`SPEC.md` states that default.", a fact about a document, and then gives an unrelated rule. The list reads as three iron rules where the issue has two. Acceptable: one top-level bullet for the trusted-proxy default, with the three netblocks, the `SPEC.md` sentence and "Forwarded headers count only when the peer is a trusted proxy." nested under it. Judgement call: finding 1 departs from the wording of the issue's definition of done. That wording came from the issue, not from sneak, and the standing rule for two-commit PRs whose first commit adds failing tests takes precedence. Model: opus-5-5
Author
Collaborator

For the reworker. Fix the two findings of #247 (comment) as their "Acceptable" lines say. Change nothing else. Rebase onto current next. make fmt, then flock -w 1800 /srv/code/tmp/.gate-smallwebwaf.lock make check; a flock timeout also exits 1, so read the output. git push --force-with-lease, label needs-review, reply one line per finding.

For the next reviewer: the two findings against the diff from 0bb947a, every changed sentence against the tree, and make check on the head. Fail only for one of these or for a bug the rework introduces.

Model: opus-5-5

**For the reworker.** Fix the two findings of https://git.eeqj.de/sneak/smallwebwaf/pulls/247#issuecomment-172387 as their "Acceptable" lines say. Change nothing else. Rebase onto current `next`. `make fmt`, then `flock -w 1800 /srv/code/tmp/.gate-smallwebwaf.lock make check`; a `flock` timeout also exits 1, so read the output. `git push --force-with-lease`, label `needs-review`, reply one line per finding. **For the next reviewer:** the two findings against the diff from `0bb947a`, every changed sentence against the tree, and `make check` on the head. Fail only for one of these or for a bug the rework introduces. Model: opus-5-5
clawbot added needs-rework and removed needs-review labels 2026-11-09 19:43:20 +01:00
clawbot force-pushed issue-246-agents-md from 0bb947ab29 to 5d75b5ce02 2026-11-09 19:46:55 +01:00 Compare
clawbot added needs-review and removed needs-rework labels 2026-11-09 19:47:01 +01:00
Author
Collaborator
  1. Fixed: a sentence after the squash rule says a two-commit PR (failing tests, then the fix) lands as both commits.
  2. Fixed: one top-level trusted-proxy bullet; the netblocks, the SPEC.md sentence and the forwarded-headers sentence are nested under it.

Model: opus-5-5

1. Fixed: a sentence after the squash rule says a two-commit PR (failing tests, then the fix) lands as both commits. 2. Fixed: one top-level trusted-proxy bullet; the netblocks, the `SPEC.md` sentence and the forwarded-headers sentence are nested under it. Model: opus-5-5
Author
Collaborator

FAIL (needs-rework).

  1. AGENTS.md lines 11–13: "A PR of exactly two commits lands as both commits: first tests that fail against the current code, then the fix with no test assertion changed." The sentence puts the condition in the wrong place. Its subject is any PR of two commits, and the part after the colon reads as a description of those commits, not as the condition. Read literally, a two-commit PR of any other shape (a change, then a fix-up) lands unsquashed, which contradicts the sentence before it. A manager merging by this file would keep both commits of such a PR. Acceptable: make the shape the condition, for example "A PR may instead be exactly two commits: first tests that fail against the current code, then the fix with no test assertion changed. Such a PR lands as both commits."

Model: opus-5-5

FAIL (`needs-rework`). 1. `AGENTS.md` lines 11–13: "A PR of exactly two commits lands as both commits: first tests that fail against the current code, then the fix with no test assertion changed." The sentence puts the condition in the wrong place. Its subject is any PR of two commits, and the part after the colon reads as a description of those commits, not as the condition. Read literally, a two-commit PR of any other shape (a change, then a fix-up) lands unsquashed, which contradicts the sentence before it. A manager merging by this file would keep both commits of such a PR. Acceptable: make the shape the condition, for example "A PR may instead be exactly two commits: first tests that fail against the current code, then the fix with no test assertion changed. Such a PR lands as both commits." Model: opus-5-5
Author
Collaborator

For the reworker. Replace the sentence that #247 (comment) quotes with its "Acceptable" wording, word for word. Change nothing else. Rebase onto current next, make fmt, then flock -w 1800 /srv/code/tmp/.gate-smallwebwaf.lock make check; a flock timeout also exits 1, so read the output. git push --force-with-lease, label needs-review, reply in one line.

For the next reviewer: that one sentence against the diff from 5d75b5c, and make check on the head. Fail only if the sentence differs from the given wording or the rework changed anything else.

Model: opus-5-5

**For the reworker.** Replace the sentence that https://git.eeqj.de/sneak/smallwebwaf/pulls/247#issuecomment-172480 quotes with its "Acceptable" wording, word for word. Change nothing else. Rebase onto current `next`, `make fmt`, then `flock -w 1800 /srv/code/tmp/.gate-smallwebwaf.lock make check`; a `flock` timeout also exits 1, so read the output. `git push --force-with-lease`, label `needs-review`, reply in one line. **For the next reviewer:** that one sentence against the diff from `5d75b5c`, and `make check` on the head. Fail only if the sentence differs from the given wording or the rework changed anything else. Model: opus-5-5
clawbot added needs-rework and removed needs-review labels 2026-11-09 20:09:35 +01:00
clawbot added 1 commit 2026-11-09 20:12:15 +01:00
AGENTS.md holds the branching model, the entrypoints, the editing rule
and two iron rules: query strings are logged as received, and the
trusted-proxy default is the RFC 1918 set. README links it; SPEC.md
step 2 now states that default and that a given list replaces it.

Model: opus-5-5
clawbot force-pushed issue-246-agents-md from 5d75b5ce02 to 92b7c4f146 2026-11-09 20:12:15 +01:00 Compare
clawbot added needs-review and removed needs-rework labels 2026-11-09 20:12:22 +01:00
Author
Collaborator
  1. Fixed: the sentence now reads word for word as the "Acceptable" wording of #247 (comment).

Model: opus-5-5

1. Fixed: the sentence now reads word for word as the "Acceptable" wording of https://git.eeqj.de/sneak/smallwebwaf/pulls/247#issuecomment-172480. Model: opus-5-5
Author
Collaborator

PASS: the root AGENTS.md, its line in the README's Documents list and the new default sentence in SPEC.md step 2 meet the definition of done of #246 and match the tree.

Model: opus-5-5

PASS: the root `AGENTS.md`, its line in the README's Documents list and the new default sentence in `SPEC.md` step 2 meet the definition of done of https://git.eeqj.de/sneak/smallwebwaf/issues/246 and match the tree. Model: opus-5-5
clawbot merged commit 3093ed8f0d into next 2026-11-09 20:43:18 +01:00
clawbot deleted branch issue-246-agents-md 2026-11-09 20:43:18 +01:00
Sign in to join this conversation.