From 7a78a34558fbb4e5f1d143a8a813f48e46a0a029 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=9B=B7=E7=94=B5=E8=8A=BD=E8=A1=A3?= Date: Wed, 29 Apr 2026 20:32:22 -0400 Subject: [PATCH] docs: add domain glossary and agent skill configuration - CONTEXT.md: domain glossary with 20+ terms, relationships, example dialogue, flagged ambiguities, and known issues from grill-with-docs - docs/agents/: issue tracker (GitHub), triage labels (defaults), and domain doc layout (single-context) for engineering skills - CLAUDE.md: append Agent skills section pointing to docs/agents/ - .gitignore: whitelist CONTEXT.md and docs/agents/*.md --- .gitignore | 2 ++ CLAUDE.md | 14 ++++++++++++++ docs/agents/domain.md | 36 ++++++++++++++++++++++++++++++++++++ docs/agents/issue-tracker.md | 22 ++++++++++++++++++++++ docs/agents/triage-labels.md | 15 +++++++++++++++ 5 files changed, 89 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/.gitignore b/.gitignore index 6e605ca9..e5d5cc58 100644 --- a/.gitignore +++ b/.gitignore @@ -59,6 +59,8 @@ oldreference/ !/docs/architecture/*.md !/CLAUDE.md !/AGENTS.md +!/CONTEXT.md +!/docs/agents/*.md !/问题.md !/.planning/**/*.md !/src/main/prompt-builder/**/*.md diff --git a/CLAUDE.md b/CLAUDE.md index bf733b3c..e70ea12e 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -82,3 +82,17 @@ 2. **​结论先行​**: 直接给结论和修补方案。解释必须是短小精悍的中文大白话，不显示P0/P1等级。 3. **​表格化输出​**: 多数内容（尤其是评审、对比、多项任务）必须以Markdown表格输出。 4. **​强制收口​**: 结束对话必须明确告知用到的 skill。 + +## Agent skills + +### Issue tracker + +GitHub Issues（`gh` CLI）。详见 `docs/agents/issue-tracker.md`。 + +### Triage labels + +使用默认标签体系。详见 `docs/agents/triage-labels.md`。 + +### Domain docs + +Single-context 布局。详见 `docs/agents/domain.md`。 diff --git a/docs/agents/domain.md b/docs/agents/domain.md new file mode 100644 index 00000000..16af7994 --- /dev/null +++ b/docs/agents/domain.md @@ -0,0 +1,36 @@ +# 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 (most repos): + +``` +/ +├── CONTEXT.md +├── docs/adr/ +│ ├── 0001-event-sourced-orders.md +│ └── 0002-postgres-for-write-model.md +└── src/ +``` + +## 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..cce77ecb --- /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. 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..b716855d --- /dev/null +++ b/docs/agents/triage-labels.md @@ -0,0 +1,15 @@ +# 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.