AGENTS.md: the repository's rules for agents #246

Closed
opened 2026-11-09 19:09:08 +01:00 by clawbot · 1 comment
Collaborator

The repository has no AGENTS.md, so its rules for agents live only in briefs. Agent guidance goes in a root AGENTS.md (standing ruling for every repo): conventions, entrypoints, iron rules and the branching model.

Definition of done, one PR into next:

  • A root AGENTS.md, short, in plain sentences, holding:
    • Branches: main is stable and next is for development; every PR is cut from next and targets it; only sneak merges next into main. Each issue lands as one squashed commit whose title ends (closes #N).
    • Entrypoints: work through the Makefile targets, which shim script/; never run go, golangci-lint or prettier directly. make check passes before every push. Link the README's Entrypoints section instead of repeating it.
    • Editing: edit files by hand; format only with make fmt, run before committing any change.
    • Iron rules:
      • The request log records query strings exactly as received. Secrets belong in POST data, and an app that puts them in a query string is fixed in the app. Never propose redacting a query string, Gitea's ?token= included.
      • The trusted-proxy default is the RFC 1918 set, 10.0.0.0/8, 172.16.0.0/12 and 192.168.0.0/16, and SPEC.md states it. Forwarded headers count only from a trusted peer.
  • README.md's Documents list links AGENTS.md in one line.
  • Every sentence matches the tree: check each claim against SPEC.md, docs/settings.md and the Makefile. SPEC.md names SWRP_TRUSTED_PROXIES at step 2, "The client is identified", but not its default: add one sentence there giving the three netblocks, and that a list given replaces them.
  • No other file changes. No CLAUDE.md and no .claude/ directory.
  • make fmt, then flock -w 1800 /srv/code/tmp/.gate-smallwebwaf.lock make check; a flock timeout also exits 1, so read the output. Label the PR needs-review.

Model: opus-5-5

The repository has no `AGENTS.md`, so its rules for agents live only in briefs. Agent guidance goes in a root `AGENTS.md` (standing ruling for every repo): conventions, entrypoints, iron rules and the branching model. **Definition of done**, one PR into `next`: - A root `AGENTS.md`, short, in plain sentences, holding: - **Branches:** `main` is stable and `next` is for development; every PR is cut from `next` and targets it; only sneak merges `next` into `main`. Each issue lands as one squashed commit whose title ends ` (closes #N)`. - **Entrypoints:** work through the `Makefile` targets, which shim `script/`; never run `go`, `golangci-lint` or prettier directly. `make check` passes before every push. Link the README's Entrypoints section instead of repeating it. - **Editing:** edit files by hand; format only with `make fmt`, run before committing any change. - **Iron rules:** - The request log records query strings exactly as received. Secrets belong in POST data, and an app that puts them in a query string is fixed in the app. Never propose redacting a query string, Gitea's `?token=` included. - The trusted-proxy default is the RFC 1918 set, `10.0.0.0/8`, `172.16.0.0/12` and `192.168.0.0/16`, and `SPEC.md` states it. Forwarded headers count only from a trusted peer. - `README.md`'s Documents list links `AGENTS.md` in one line. - Every sentence matches the tree: check each claim against `SPEC.md`, `docs/settings.md` and the `Makefile`. `SPEC.md` names `SWRP_TRUSTED_PROXIES` at step 2, "The client is identified", but not its default: add one sentence there giving the three netblocks, and that a list given replaces them. - No other file changes. No `CLAUDE.md` and no `.claude/` directory. - `make fmt`, then `flock -w 1800 /srv/code/tmp/.gate-smallwebwaf.lock make check`; a `flock` timeout also exits 1, so read the output. Label the PR `needs-review`. Model: opus-5-5
clawbot self-assigned this 2026-11-09 19:09:08 +01:00
Author
Collaborator

Built in #247: a root AGENTS.md, its link in the README, and the trusted-proxy default in SPEC.md step 2.

Model: opus-5-5

Built in https://git.eeqj.de/sneak/smallwebwaf/pulls/247: a root `AGENTS.md`, its link in the README, and the trusted-proxy default in `SPEC.md` step 2. 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/smallwebwaf#246