Skip to content

docs: add AGENTS.md, ground-truth.json, and Makefile#627

Merged
BreakableHoodie merged 4 commits into
mainfrom
docs/agents-ground-truth-makefile
Jul 17, 2026
Merged

docs: add AGENTS.md, ground-truth.json, and Makefile#627
BreakableHoodie merged 4 commits into
mainfrom
docs/agents-ground-truth-makefile

Conversation

@BreakableHoodie

Copy link
Copy Markdown
Owner

Summary

Three artifacts that give every agent and human the same operating manual, per Dre's direction:

  • AGENTS.md (agents.md standard) — tool-agnostic instructions for Claude Code, OpenCode, Codex, Cursor, etc.: Makefile-first commands, the prod-breaking invariant shortlist (full catalogue stays in CLAUDE.md), the owner doctrines (lean-and-performant, clean links, no AI bios, highest-confidence facts), and PR rules including nothing merges unless ALL CI is green.
  • ground-truth.json — machine-readable slow-moving canon: Vol 17 target-event facts, the six-venue canon with DB ids, all 19 event slugs/ids/dates, timezone + after-midnight constants, infra identifiers, process rules. Live data (lineups, profiles) deliberately excluded — that belongs to the database.
  • Makefile — canonical task runner: make gate (full pre-commit), make e2e (the complete local Playwright recipe: isolated D1 seed, wrangler serve with pidfile, run, guaranteed cleanup), make schema-check, etc. Real exit codes structurally end the cmd | tail exit-masking bug class.

Draft — open for Dre's review of content choices (especially ground-truth.json's scope) before merge.

What changed

File Purpose
AGENTS.md Agent operating manual (agents.md standard)
ground-truth.json Machine-readable project canon (JSON-valid, verified against prod DB queries this session)
Makefile Canonical gates + E2E recipe (validated: make help, make lint run green)

Security / correctness notes

ground-truth.json includes the prod D1 database name and id — these are identifiers, not credentials (already visible in wrangler.toml comments and useless without account auth). No secrets in any file.

Verification

  • Tests: n/a — docs + tooling only; make lint exercised end-to-end (0 errors)
  • ESLint: unaffected
  • Format check: n/a for md/json/Makefile (outside prettier globs)
  • Build: unaffected
  • validate:openapi: n/a
  • Manual smoke: python3 -m json.tool ground-truth.json valid; make help lists all targets; make lint green

Built by Theo · Reviewed by Theo · 🤖 Claude Code

AGENTS.md (agents.md standard) gives every coding agent — Claude,
OpenCode, Codex, Cursor — one predictable operating manual: commands,
prod-breaking invariants, owner doctrines (lean/clean-links/no-AI-
bios/highest-confidence), and PR rules including the all-CI-green
merge rule. ground-truth.json is the machine-readable slow-moving
canon (venue/event ids and dates, constants, infra identifiers) so
agents stop re-deriving or guessing facts. The Makefile is the
canonical task runner — real exit codes end the pipe-masking bug
class, and make e2e codifies the full local Playwright recipe that
previously lived in session notes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@BreakableHoodie BreakableHoodie added documentation Improvements or additions to documentation priority:p2 Medium priority labels Jul 17, 2026
Copilot AI review requested due to automatic review settings July 17, 2026 18:56

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Searching for band links is the time sink; validation is a 2-second
owner yes/no. The probe checks canonical bandcamp subdomain patterns
for every linkless band with plain HTTP (no search engine, no AI) and
buckets results: AUTO (exact name match + Ontario location — doctrine-
safe), REVIEW (page exists, identity unproven), NONE. Existence is
not identity: unclaimed subdomains redirect to signup, and popular
names are taken by unrelated acts.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 17, 2026 19:00

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

The unthrottled 93-band run tripped bandcamp's rate limiter: late 429s
were silently bucketed as NONE (false negatives) and the location scan
never got a fair test (it also only read the first 120KB — the
location markup sits deep in the sidebar). Requests now space 2s apart
with a 30s backoff on 429; rate-limited bands land in a RETRY bucket,
never NONE.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 17, 2026 19:07

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

Copilot AI review requested due to automatic review settings July 17, 2026 19:30

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@BreakableHoodie
BreakableHoodie marked this pull request as ready for review July 17, 2026 19:31
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@BreakableHoodie
BreakableHoodie merged commit f96912f into main Jul 17, 2026
21 checks passed
@BreakableHoodie
BreakableHoodie deleted the docs/agents-ground-truth-makefile branch July 17, 2026 19:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation priority:p2 Medium priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants