From 870512701a1f37fa2ccb169a29a4c9549d2c8a6b Mon Sep 17 00:00:00 2001 From: Donncha O Caoimh <5656673+donnchawp@users.noreply.github.com> Date: Tue, 19 May 2026 16:51:37 +0100 Subject: [PATCH 1/4] Add agent skills configuration Scaffold AGENTS.md, CLAUDE.md, and docs/agents/ so AI agent skills (triage, to-issues, diagnose, tdd, etc.) know where issues live, which triage labels to apply, and how to read domain docs in this repo. - AGENTS.md: top-level agent instructions with the Agent skills block - CLAUDE.md: re-exports AGENTS.md via @AGENTS.md syntax - docs/agents/issue-tracker.md: GitHub conventions (gh CLI) - docs/agents/triage-labels.md: canonical triage label mapping - docs/agents/domain.md: single-context CONTEXT.md / docs/adr layout --- AGENTS.md | 17 ++++++++++++ CLAUDE.md | 1 + docs/agents/domain.md | 51 ++++++++++++++++++++++++++++++++++++ docs/agents/issue-tracker.md | 22 ++++++++++++++++ docs/agents/triage-labels.md | 21 +++++++++++++++ 5 files changed, 112 insertions(+) create mode 100644 AGENTS.md create mode 100644 CLAUDE.md create mode 100644 docs/agents/domain.md create mode 100644 docs/agents/issue-tracker.md create mode 100644 docs/agents/triage-labels.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..11b9a053 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,17 @@ +# AGENTS.md + +Agent instructions for the wp-super-cache repository. + +## Agent skills + +### Issue tracker + +Issues live on GitHub at `Automattic/wp-super-cache` and are managed with the `gh` CLI. See `docs/agents/issue-tracker.md`. + +### Triage labels + +Five canonical triage labels (`needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human`, `wontfix`) plus categories `bug` and `enhancement`. See `docs/agents/triage-labels.md`. + +### Domain docs + +Single-context layout — one `CONTEXT.md` and `docs/adr/` at the repo root. See `docs/agents/domain.md`. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 00000000..43c994c2 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +@AGENTS.md diff --git a/docs/agents/domain.md b/docs/agents/domain.md new file mode 100644 index 00000000..ffea3b06 --- /dev/null +++ b/docs/agents/domain.md @@ -0,0 +1,51 @@ +# Domain Docs + +How the engineering skills should consume this repo's domain documentation when exploring the codebase. + +## Before exploring, read these + +- **`CONTEXT.md`** at the repo root, or +- **`CONTEXT-MAP.md`** at the repo root if it exists — it points at one `CONTEXT.md` per context. Read each one relevant to the topic. +- **`docs/adr/`** — read ADRs that touch the area you're about to work in. In multi-context repos, also check `src//docs/adr/` for context-scoped decisions. + +If any of these files don't exist, **proceed silently**. Don't flag their absence; don't suggest creating them upfront. The producer skill (`/grill-with-docs`) creates them lazily when terms or decisions actually get resolved. + +## File structure + +Single-context repo (this repo): + +``` +/ +├── CONTEXT.md +├── docs/adr/ +│ ├── 0001-event-sourced-orders.md +│ └── 0002-postgres-for-write-model.md +└── src/ +``` + +Multi-context repo (presence of `CONTEXT-MAP.md` at the root): + +``` +/ +├── CONTEXT-MAP.md +├── docs/adr/ ← system-wide decisions +└── src/ + ├── ordering/ + │ ├── CONTEXT.md + │ └── docs/adr/ ← context-specific decisions + └── billing/ + ├── CONTEXT.md + └── docs/adr/ +``` + +## Use the glossary's vocabulary + +When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly avoids. + +If the concept you need isn't in the glossary yet, that's a signal — either you're inventing language the project doesn't use (reconsider) or there's a real gap (note it for `/grill-with-docs`). + +## Flag ADR conflicts + +If your output contradicts an existing ADR, surface it explicitly rather than silently overriding: + +> _Contradicts ADR-0007 (event-sourced orders) — but worth reopening because…_ diff --git a/docs/agents/issue-tracker.md b/docs/agents/issue-tracker.md new file mode 100644 index 00000000..692b3fb2 --- /dev/null +++ b/docs/agents/issue-tracker.md @@ -0,0 +1,22 @@ +# Issue tracker: GitHub + +Issues and PRDs for this repo live as GitHub issues at `Automattic/wp-super-cache`. Use the `gh` CLI for all operations. + +## Conventions + +- **Create an issue**: `gh issue create --title "..." --body "..."`. Use a heredoc for multi-line bodies. +- **Read an issue**: `gh issue view --comments`, filtering comments by `jq` and also fetching labels. +- **List issues**: `gh issue list --state open --json number,title,body,labels,comments --jq '[.[] | {number, title, body, labels: [.labels[].name], comments: [.comments[].body]}]'` with appropriate `--label` and `--state` filters. +- **Comment on an issue**: `gh issue comment --body "..."` +- **Apply / remove labels**: `gh issue edit --add-label "..."` / `--remove-label "..."` +- **Close**: `gh issue close --comment "..."` + +Infer the repo from `git remote -v` — `gh` does this automatically when run inside a clone. + +## When a skill says "publish to the issue tracker" + +Create a GitHub issue. + +## When a skill says "fetch the relevant ticket" + +Run `gh issue view --comments`. diff --git a/docs/agents/triage-labels.md b/docs/agents/triage-labels.md new file mode 100644 index 00000000..fa930930 --- /dev/null +++ b/docs/agents/triage-labels.md @@ -0,0 +1,21 @@ +# Triage Labels + +The skills speak in terms of five canonical triage roles. This file maps those roles to the actual label strings used in this repo's issue tracker. + +| Canonical role | Label in our tracker | Meaning | +| ------------------ | -------------------- | ---------------------------------------- | +| `needs-triage` | `needs-triage` | Maintainer needs to evaluate this issue | +| `needs-info` | `needs-info` | Waiting on reporter for more information | +| `ready-for-agent` | `ready-for-agent` | Fully specified, ready for an AFK agent | +| `ready-for-human` | `ready-for-human` | Requires human implementation | +| `wontfix` | `wontfix` | Will not be actioned | + +Category labels (applied alongside one state label): `bug`, `enhancement`. + +When a skill mentions a role (e.g. "apply the AFK-ready triage label"), use the corresponding label string from this table. + +## Repo-specific notes + +- `wontfix`, `bug`, `enhancement` already exist in the repo. +- `needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human` were created during setup. +- The repo has other historical labels (`Needs Review`, `reporter feedback`, `PRIORITY`, `[Status] In Progress`, etc.) that are **not** part of the triage state machine. Leave them alone unless asked. From a8b3c3ab5ee163dd255baab389702a3850ee04b4 Mon Sep 17 00:00:00 2001 From: Donncha O Caoimh <5656673+donnchawp@users.noreply.github.com> Date: Tue, 19 May 2026 17:38:45 +0100 Subject: [PATCH 2/4] Move pnpm onlyBuiltDependencies to pnpm-workspace.yaml pnpm 11 no longer reads the "pnpm" field from package.json and warns "The 'pnpm' field in package.json is no longer read by pnpm." Because unrs-resolver's build script was no longer approved, pnpm 11 treated the ignored build as fatal (ERR_PNPM_IGNORED_BUILDS) and failed the install. Move the setting to pnpm-workspace.yaml (pnpm 11's new home for it) and drop the now-dead pnpm field from package.json. --- tests/e2e/package.json | 5 ----- tests/e2e/pnpm-workspace.yaml | 2 ++ 2 files changed, 2 insertions(+), 5 deletions(-) create mode 100644 tests/e2e/pnpm-workspace.yaml diff --git a/tests/e2e/package.json b/tests/e2e/package.json index 5897ee4f..cf003987 100644 --- a/tests/e2e/package.json +++ b/tests/e2e/package.json @@ -11,11 +11,6 @@ "test:run": "jest --runInBand", "typecheck": "tsgo --noEmit" }, - "pnpm": { - "onlyBuiltDependencies": [ - "unrs-resolver" - ] - }, "devDependencies": { "@jest/globals": "^30.0.0", "@types/node": "^24.12.0", diff --git a/tests/e2e/pnpm-workspace.yaml b/tests/e2e/pnpm-workspace.yaml new file mode 100644 index 00000000..d7265d29 --- /dev/null +++ b/tests/e2e/pnpm-workspace.yaml @@ -0,0 +1,2 @@ +onlyBuiltDependencies: + - unrs-resolver From 921a669b8432b05e4b723a371c665f4f6dac5fbc Mon Sep 17 00:00:00 2001 From: Donncha O Caoimh <5656673+donnchawp@users.noreply.github.com> Date: Tue, 19 May 2026 17:46:07 +0100 Subject: [PATCH 3/4] Revert "Move pnpm onlyBuiltDependencies to pnpm-workspace.yaml" This reverts commit a8b3c3ab5ee163dd255baab389702a3850ee04b4. --- tests/e2e/package.json | 5 +++++ tests/e2e/pnpm-workspace.yaml | 2 -- 2 files changed, 5 insertions(+), 2 deletions(-) delete mode 100644 tests/e2e/pnpm-workspace.yaml diff --git a/tests/e2e/package.json b/tests/e2e/package.json index cf003987..5897ee4f 100644 --- a/tests/e2e/package.json +++ b/tests/e2e/package.json @@ -11,6 +11,11 @@ "test:run": "jest --runInBand", "typecheck": "tsgo --noEmit" }, + "pnpm": { + "onlyBuiltDependencies": [ + "unrs-resolver" + ] + }, "devDependencies": { "@jest/globals": "^30.0.0", "@types/node": "^24.12.0", diff --git a/tests/e2e/pnpm-workspace.yaml b/tests/e2e/pnpm-workspace.yaml deleted file mode 100644 index d7265d29..00000000 --- a/tests/e2e/pnpm-workspace.yaml +++ /dev/null @@ -1,2 +0,0 @@ -onlyBuiltDependencies: - - unrs-resolver From 4bfa6425ab8436c2c64c4510c02368f80f43476d Mon Sep 17 00:00:00 2001 From: Donncha O Caoimh <5656673+donnchawp@users.noreply.github.com> Date: Tue, 19 May 2026 17:47:05 +0100 Subject: [PATCH 4/4] Pin pnpm to v10 in E2E workflow pnpm/action-setup@v4 was set to version: latest, which now pulls pnpm 11. pnpm 11 changed where onlyBuiltDependencies is read from (moved out of package.json) and made ignored builds a fatal install error (ERR_PNPM_IGNORED_BUILDS), breaking the E2E install step. Pin to pnpm v10 so the existing package.json "pnpm" field is honored and the install completes. Avoids chasing pnpm 11's evolving config surface. --- .github/workflows/e2e-tests.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml index 712ed829..e4f94b60 100644 --- a/.github/workflows/e2e-tests.yml +++ b/.github/workflows/e2e-tests.yml @@ -16,7 +16,7 @@ jobs: - uses: pnpm/action-setup@v4 with: - version: latest + version: 10 - uses: actions/setup-node@v4 with: