From fc21e1595e7da33732ca85ba6d60763165d84567 Mon Sep 17 00:00:00 2001 From: Artur Shiriev Date: Sat, 19 Sep 2026 13:48:56 +0300 Subject: [PATCH] docs: restore the agent artifacts to the setup skill's templates MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Brings this repo's agent artifacts back to the setup skill's seed templates. They had drifted — sections renamed and reordered, wording rephrased, and in places an older copy of the template than the skill now ships (for example `issue-tracker.md` predates the wayfinding section). Template-owned wording is restored verbatim. Anything the template has no slot for is kept: sections this repo added are carried over unchanged, and repo-specific facts inside template sections are preserved rather than reset away. `AGENTS.md` moves from a bulleted variant to the block the skill writes: one `###` sub-block per artifact, each a one-line summary and a pointer. --- AGENTS.md | 15 ++++++++---- docs/agents/domain.md | 45 ++++++++++++------------------------ docs/agents/issue-tracker.md | 17 +++++++++++--- docs/agents/triage-labels.md | 4 +--- 4 files changed, 41 insertions(+), 40 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 543f7b1..34c299b 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -83,7 +83,14 @@ description, and PyPI does not rewrite relative links, so a relative one 404s on ## Agent skills -- **Issues and specs** — GitHub Issues on `modern-python/httpware`, via `gh`: - [`docs/agents/issue-tracker.md`](docs/agents/issue-tracker.md) -- **Triage labels** — the five canonical roles: [`docs/agents/triage-labels.md`](docs/agents/triage-labels.md) -- **Domain docs** — single-context, `CONTEXT.md` + `docs/adr/`: [`docs/agents/domain.md`](docs/agents/domain.md) +### Issue tracker + +GitHub issues on `modern-python/httpware`, via `gh`. See `docs/agents/issue-tracker.md`. + +### Triage labels + +The five canonical roles, each label string equal to its name. See `docs/agents/triage-labels.md`. + +### Domain docs + +Single-context: `CONTEXT.md` and `docs/adr/` at the repo root. See `docs/agents/domain.md`. diff --git a/docs/agents/domain.md b/docs/agents/domain.md index 3ea0dc1..5d26f66 100644 --- a/docs/agents/domain.md +++ b/docs/agents/domain.md @@ -1,46 +1,38 @@ # Domain Docs -How the engineering skills should consume this repo's domain documentation when exploring the -codebase. This repo is **single-context**. +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: what this repo is, and the glossary. -- **`docs/adr/`**: read the decision records that touch the area you're about to work in. +- **`CONTEXT.md`** at the repo root. +- **`docs/adr/`**: read ADRs that touch the area you're about to work in. -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 creates them lazily when terms or decisions -actually get resolved. +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 +Single-context repo: + ``` / ├── CONTEXT.md ├── docs/adr/ -│ ├── 0001-….md -│ └── 0002-….md -├── src/httpware/ -└── tests/ +│ ├── 0001-no-opentelemetry-middleware.md +│ └── 0002-sync-async-parity-is-hand-maintained.md +└── src/ ``` -There is no `CONTEXT-MAP.md` and no per-package `CONTEXT.md`: one package, one context. There is -also no `architecture/` and no `planning/` — the present is the source, and what must stay true is -a test whose docstring opens `INVARIANT:`. - ## 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: write `middleware` and not `hook`, `terminal` and not `transport`, `decoder` and not -`adapter`, `cap` and not `limit`. +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`). +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 -## Where a new fact goes +If your output contradicts an existing ADR, surface it explicitly rather than silently overriding: -Run the admission check in `AGENTS.md` before writing anything down. +> _Contradicts ADR-0001 (no opentelemetry middleware), but worth reopening because…_ ## Link style inside `docs/` @@ -52,10 +44,3 @@ working in both renderings: - **Never link from a file inside `docs/` to a path outside it.** It cannot resolve in both renderings: MkDocs emits `links.not_found` and ships the link verbatim, so it 404s on the site. Cite `src/httpware/...`, `tests/...`, and root files as inline code, never as links. - -## Flag ADR conflicts - -If your output contradicts an existing decision record, surface it explicitly rather than silently -overriding: - -> _Contradicts ADR-NNNN (its title), but worth reopening because…_ diff --git a/docs/agents/issue-tracker.md b/docs/agents/issue-tracker.md index a6ef151..b258aeb 100644 --- a/docs/agents/issue-tracker.md +++ b/docs/agents/issue-tracker.md @@ -1,6 +1,6 @@ # Issue tracker: GitHub -Issues and PRDs for this repo live as GitHub issues. Use the `gh` CLI for all operations. +Issues and specs for this repo live as GitHub issues. Use the `gh` CLI for all operations. ## Conventions @@ -11,7 +11,7 @@ Issues and PRDs for this repo live as GitHub issues. Use the `gh` CLI for all op - **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. This repo's remote is `modern-python/httpware`. +Infer the repo from `git remote -v`; `gh` does this automatically when run inside a clone. ## Pull requests as a triage surface @@ -23,7 +23,7 @@ When set to `yes`, PRs run through the same labels and states as issues, using t - **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`. +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" @@ -32,3 +32,14 @@ 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 index 83e93f1..b716855 100644 --- a/docs/agents/triage-labels.md +++ b/docs/agents/triage-labels.md @@ -2,7 +2,7 @@ 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 | +| 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 | @@ -10,8 +10,6 @@ The skills speak in terms of five canonical triage roles. This file maps those r | `ready-for-human` | `ready-for-human` | Requires human implementation | | `wontfix` | `wontfix` | Will not be actioned | -`wontfix` already exists in this repo's GitHub labels. The other four are created on first use by `/triage` (`gh label create `). - 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.