diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..09f0d16 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,13 @@ +## Agent skills + +### Issue tracker + +Issues tracked on Gitea at git.gabrielkaszewski.dev (GKaszewski/k-tv). See `docs/agents/issue-tracker.md`. + +### Triage labels + +Default label vocabulary. See `docs/agents/triage-labels.md`. + +### Domain docs + +Multi-context (frontend + backend). See `docs/agents/domain.md`. diff --git a/docs/agents/domain.md b/docs/agents/domain.md new file mode 100644 index 0000000..327511e --- /dev/null +++ b/docs/agents/domain.md @@ -0,0 +1,38 @@ +# Domain Docs + +How the engineering skills should consume this repo's domain documentation when exploring the codebase. + +## Before exploring, read these + +- **`CONTEXT-MAP.md`** at the repo root — 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. Also check context-scoped `docs/adr/` directories for context-specific 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 + +Multi-context repo: + +``` +/ +├── CONTEXT-MAP.md +├── docs/adr/ ← system-wide decisions +├── k-tv-frontend/ +│ ├── CONTEXT.md +│ └── docs/adr/ ← frontend-specific decisions +└── crates/ + ├── CONTEXT.md + └── docs/adr/ ← backend-specific decisions +``` + +## 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 — but worth reopening because…_ diff --git a/docs/agents/issue-tracker.md b/docs/agents/issue-tracker.md new file mode 100644 index 0000000..e86ccf2 --- /dev/null +++ b/docs/agents/issue-tracker.md @@ -0,0 +1,20 @@ +# Issue tracker: Gitea + +Issues and PRDs for this repo live on the Gitea instance at `git.gabrielkaszewski.dev`, repo `GKaszewski/k-tv`. Use the Gitea MCP tools for all operations. + +## Conventions + +- **Create an issue**: `mcp__gitea__issue_write` with method `create`, owner `GKaszewski`, repo `k-tv` +- **Read an issue**: `mcp__gitea__issue_read` with method `get` +- **List issues**: `mcp__gitea__list_issues` with owner `GKaszewski`, repo `k-tv` +- **Comment on an issue**: `mcp__gitea__issue_write` with method `add_comment` +- **Apply / remove labels**: `mcp__gitea__issue_write` with method `add_labels` / `remove_label` +- **Close**: `mcp__gitea__issue_write` with method `update`, state `closed` + +## When a skill says "publish to the issue tracker" + +Create a Gitea issue using the MCP tools. + +## When a skill says "fetch the relevant ticket" + +Use `mcp__gitea__issue_read` with method `get`. diff --git a/docs/agents/triage-labels.md b/docs/agents/triage-labels.md new file mode 100644 index 0000000..ad2d1ca --- /dev/null +++ b/docs/agents/triage-labels.md @@ -0,0 +1,13 @@ +# 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.