diff --git a/AGENTS.md b/AGENTS.md index 58320a8..2528807 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -34,3 +34,10 @@ does not manage their location or lifecycle. ```sh deno task ci ``` + +## Agent skills + +This repo uses a lightweight skills/config scaffold under docs/agents/. The +canonical triage state labels are defined in docs/agents/triage-labels.md. For +how to file, label, and decide issues, follow docs/agents/issue-tracker.md. +Domain expectations live in docs/agents/domain.md. diff --git a/docs/agents/domain.md b/docs/agents/domain.md new file mode 100644 index 0000000..0878db0 --- /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 `/domain-modeling` skill +(reached via `/grill-with-docs` and `/improve-codebase-architecture`) creates +them lazily when terms or decisions actually get resolved. + +## File structure + +This repo is **single-context**: one `CONTEXT.md` and `docs/adr/` at the root. + +``` +/ +├── CONTEXT.md +├── docs/adr/ +│ ├── 0001-example-decision.md +│ └── 0002-another-decision.md +└── src/ +``` + +If a `CONTEXT-MAP.md` ever appears at the root, this repo has become +multi-context and the per-context layout applies instead. + +## 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 `/domain-modeling`). + +## 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 0000000..1f34188 --- /dev/null +++ b/docs/agents/issue-tracker.md @@ -0,0 +1,80 @@ +# Issue tracker: GitHub + +Issues and specs for this repo live as GitHub issues. 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. + +## Pull requests as a triage surface + +**PRs as a request surface: no.** _(Set to `yes` if this repo treats external +PRs as feature requests; `/triage` reads this flag.)_ + +When set to `yes`, PRs run through the same labels and states as issues, using +the `gh pr` equivalents: + +- **Read a PR**: `gh pr view --comments` and `gh pr diff ` for + the diff. +- **List external PRs for triage**: + `gh pr list --state open --json number,title,body,labels,author,authorAssociation,comments` + then keep only `authorAssociation` of `CONTRIBUTOR`, `FIRST_TIME_CONTRIBUTOR`, + or `NONE` (drop `OWNER`/`MEMBER`/`COLLABORATOR`). +- **Comment / label / close**: `gh pr comment`, + `gh pr edit --add-label`/`--remove-label`, `gh pr close`. + +GitHub shares one number space across issues and PRs, so a bare `#42` may be +either — resolve with `gh pr view 42` and fall back to `gh issue view 42`. + +## 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`. + +## Wayfinding operations + +Used by `/wayfinder`. The **map** is a single issue with **child** issues as +tickets. + +- **Map**: a single issue labelled `wayfinder:map`, holding the Notes / + Decisions-so-far / Fog body. `gh issue create --label wayfinder:map`. +- **Child ticket**: an issue linked to the map as a GitHub sub-issue (`gh api` + on the sub-issues endpoint). Where sub-issues aren't enabled, add the child to + a task list in the map body and put `Part of #` at the top of the child + body. Labels: `wayfinder:` (`research`/`prototype`/`grilling`/`task`). + Once claimed, the ticket is assigned to the driving dev. +- **Blocking**: GitHub's **native issue dependencies** — the canonical, + UI-visible representation. Add an edge with + `gh api --method POST repos///issues//dependencies/blocked_by -F issue_id=`, + where `` is the blocker's numeric **database id** + (`gh api repos///issues/ --jq .id`, _not_ the `#number` or + `node_id`). GitHub reports `issue_dependencies_summary.blocked_by` (open + blockers only — the live gate). Where dependencies aren't available, fall back + to a `Blocked by: #, #` line at the top of the child body. A ticket is + unblocked when every blocker is closed. +- **Frontier query**: list the map's open children + (`gh issue list --state open`, scoped to the map's sub-issues / task list), + drop any with an open blocker (`issue_dependencies_summary.blocked_by > 0`, or + an open issue in the `Blocked by` line) or an assignee; first in map order + wins. +- **Claim**: `gh issue edit --add-assignee @me` — the session's first write. +- **Resolve**: `gh issue comment --body ""`, then + `gh issue close `, then append a context pointer (gist + link) to the map's + Decisions-so-far. diff --git a/docs/agents/triage-labels.md b/docs/agents/triage-labels.md new file mode 100644 index 0000000..a4d55d6 --- /dev/null +++ b/docs/agents/triage-labels.md @@ -0,0 +1,34 @@ +# 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. + +| Label in mattpocock/skills | 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 | + +When a skill mentions a role (e.g. "apply the AFK-ready triage label"), use the +corresponding label string from this table. + +Edit the right-hand column to match whatever vocabulary you actually use. + +## Category labels + +Categories are separate from the state above, and every triaged issue should +carry exactly one of them: + +| Category | Label | +| ------------- | ------------- | +| `bug` | `bug` | +| `enhancement` | `enhancement` | + +Both already exist in this tracker as GitHub defaults. Note that `wontfix` is +also a GitHub default label — reuse it rather than creating a second one. + +A decision or proposal issue fits neither `bug` nor `enhancement`. Record it as +`needs-triage` and leave it unlabeled by category rather than mislabelling it; a +maintainer decides what it becomes.