From 98f66e08be6ab13b175a472e2cef21c139dff3cc Mon Sep 17 00:00:00 2001 From: Avi Yashchin <3144839+aviyashchin@users.noreply.github.com> Date: Thu, 1 Oct 2026 01:23:49 -0400 Subject: [PATCH] docs: configure Matt Pocock engineering skills (Subconscious-ai/market-ontology#387) Add docs/agents/ (GitHub Issues tracker, triage labels, domain-doc layout) and link it from the agent instructions, so wayfinder, to-spec, to-tickets and afk publish maps, specs and tickets to this repository's issues. Co-Authored-By: Claude Opus 5.5 --- CLAUDE.md | 4 +++ docs/agents/domain.md | 51 ++++++++++++++++++++++++++++++++++++ docs/agents/issue-tracker.md | 43 ++++++++++++++++++++++++++++++ docs/agents/triage-labels.md | 17 ++++++++++++ 4 files changed, 115 insertions(+) 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/CLAUDE.md b/CLAUDE.md index b1ccf89..6f4f8bf 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -154,3 +154,7 @@ Repository conventions: - Tests: `tests/test_.py`, class-based, add success + failure tests per handler - Never commit `AUTH0_JWT_TOKEN`; use `Authorization: Bearer` not query param tokens - Ruff config: `line-length = 100`, rules E/F/I/N/W + +## Agent skills + +See `docs/agents/` for the issue tracker (GitHub Issues), triage labels and domain-doc layout. diff --git a/docs/agents/domain.md b/docs/agents/domain.md new file mode 100644 index 0000000..3bde2bb --- /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**. Until they exist, use the glossary and decision records that this repo's `AGENTS.md` or `CLAUDE.md` already names. 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 + +Single-context repo (most repos): + +``` +/ +├── 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 `/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..648b8b7 --- /dev/null +++ b/docs/agents/issue-tracker.md @@ -0,0 +1,43 @@ +# Issue tracker: GitHub + +Issues and specs for this repo live as GitHub issues in `Subconscious-ai/ghostshell`. Use the `gh` CLI for all operations. `gh` infers the repo from `git remote -v` inside a clone; pass `-R Subconscious-ai/ghostshell` when working outside a clone or from a fork. + +## Conventions + +- **Create an issue**: `gh issue create --title "..." --body "..."`. Use a heredoc for multi-line bodies. +- **Read an issue**: `gh issue view --json number,title,body,state,labels,comments`, filtering with `--jq`. +- **List issues**: `gh issue list --state open --limit 1000 --json number,title,body,labels,comments --jq '[.[] | {number, title, body, labels: [.labels[].name], comments: [.comments[].body]}]'` with appropriate `--label` and `--state` filters. Keep `--limit`; the default returns only 30. +- **Comment on an issue**: `gh issue comment --body "..."` +- **Apply / remove labels**: `gh issue edit --add-label "..."` / `--remove-label "..."`. Applying a label that does not exist fails; create it first with `gh label create ""`. +- **Close**: `gh issue close --comment "..."` + +## 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 --limit 1000 --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 --json number,title,body,state,labels,comments`. + +## Wayfinding operations + +Used by `/wayfinder`. The **map** is a single issue with **child** issues as tickets. Create each `wayfinder:*` label with `gh label create` the first time it is needed. + +- **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/Subconscious-ai/ghostshell/issues//dependencies/blocked_by -F issue_id=`, where `` is the blocker's numeric **database id** (`gh api repos/Subconscious-ai/ghostshell/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 children in map order with `gh api --paginate repos/Subconscious-ai/ghostshell/issues//sub_issues --jq '.[] | {number, state}'` (or read the map body's task list). For each open child, read `gh api repos/Subconscious-ai/ghostshell/issues/ --jq '{assignees: [.assignees[].login], blocked_by: .issue_dependencies_summary.blocked_by}'`, or its `Blocked by` line when dependencies aren't available. Drop any child with `blocked_by > 0`, an open blocker, or an assignee; the first remaining child 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..02b6659 --- /dev/null +++ b/docs/agents/triage-labels.md @@ -0,0 +1,17 @@ +# 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. + +All five labels exist in this repo's GitHub Issues. If one is missing, create it with `gh label create "