From 28ab30a58a57fe4025b3ff043c8e779e3ceab258 Mon Sep 17 00:00:00 2001 From: Artur Shiriev Date: Sat, 19 Sep 2026 13:50:18 +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 | 13 +++++++-- docs/agents/domain.md | 51 ++++++++++-------------------------- docs/agents/issue-tracker.md | 45 +++++++++++++++++++++++++++++++ docs/agents/triage-labels.md | 15 +++++++++++ 4 files changed, 85 insertions(+), 39 deletions(-) create mode 100644 docs/agents/issue-tracker.md create mode 100644 docs/agents/triage-labels.md diff --git a/AGENTS.md b/AGENTS.md index a7ece59..ad22059 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -33,5 +33,14 @@ description, and PyPI does not rewrite relative links, so a relative one 404s on ## Agent skills -- **Domain docs** — single-context, `CONTEXT.md` + `docs/adr/`: - [`docs/agents/domain.md`](docs/agents/domain.md) +### Issue tracker + +GitHub issues on `modern-python/modern-di-faststream`, 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 727f114..eaa8e39 100644 --- a/docs/agents/domain.md +++ b/docs/agents/domain.md @@ -1,64 +1,41 @@ # 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 package 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 -├── modern_di_faststream/ ← the whole implementation, one module -├── examples/ -└── tests/ +│ ├── 0001-keep-dimiddlewarefactory.md +│ └── 0002-install-middleware-on-startup.md +└── modern_di_faststream/ ``` -There is no `CONTEXT-MAP.md` and no per-package `CONTEXT.md`: one repo, 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 (an issue title, a refactor proposal, a hypothesis, a test -name), use the term as defined in `CONTEXT.md`, and honor its `_Avoid_:` lines — those synonyms are -rejected on purpose. Write `root container` and not `app container`. +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. -This package is a thin adapter, so most domain terms belong upstream, not here: `Container`, -`Provider`, `Group`, `Scope`, `Resolution`, `Override` are -[`modern-di`](https://github.com/modern-python/modern-di)'s, and `broker`, `subscriber`, -`middleware`, `StreamMessage` are FastStream's. Do not redefine a term either project already -defines. +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 is in neither, 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 (keep dimiddlewarefactory), but worth reopening because…_ ## Link style inside `docs/` The files under `docs/` are read on GitHub, and CI runs an offline link check over every Markdown file in the repo. Between files inside `docs/`, use a plain relative `.md` link — from one ADR to another, that is `[ADR-NNNN](NNNN-slug.md)`. - -## 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…_ - -A decision's **Revisit trigger** names the concrete signal that should reopen it. If that signal has -fired, say so. diff --git a/docs/agents/issue-tracker.md b/docs/agents/issue-tracker.md new file mode 100644 index 0000000..b258aeb --- /dev/null +++ b/docs/agents/issue-tracker.md @@ -0,0 +1,45 @@ +# 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..b716855 --- /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.