From 719fbf9a457bae3dc2b312fcff6371a4f5e5b34b Mon Sep 17 00:00:00 2001 From: Gilbert Sanchez Date: Sun, 20 Sep 2026 12:15:15 -0700 Subject: [PATCH] Add agent skill config: issue tracker, triage labels, domain docs AGENTS.md points agents at GitHub issues (gh CLI), the default five-role triage label vocabulary, and a single-context domain glossary. CONTEXT.md captures the PSKoans domain vocabulary (Koan, Topic, Blank, Karma, Module, Kata, etc.). --- AGENTS.md | 26 ++++++++++++++++++ CONTEXT.md | 51 ++++++++++++++++++++++++++++++++++++ docs/agents/domain.md | 36 +++++++++++++++++++++++++ docs/agents/issue-tracker.md | 45 +++++++++++++++++++++++++++++++ docs/agents/triage-labels.md | 15 +++++++++++ 5 files changed, 173 insertions(+) create mode 100644 AGENTS.md create mode 100644 CONTEXT.md 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/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..ca7ba854 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,26 @@ +## Build & test + +Build is psake-driven via `build.ps1`, which wraps `psakeFile.ps1` (PowerShellBuild-based). + +- First-time setup (installs PSDepend/PowerShellBuild/Pester into the current user scope): `.\build.ps1 -Bootstrap -Task Init`. Without `-Task Init`, `-Bootstrap` still installs deps but then falls through to the `Default` task (`Test`). +- Run the full test suite (stages the module, then runs PSScriptAnalyzer + Pester): `.\build.ps1 -Task Test` +- Run only Pester, without analysis: `.\build.ps1 -Task Pester` +- Stage the module without testing: `.\build.ps1 -Task Build` +- List all available tasks: `.\build.ps1 -Help` +- No `-Task` runs the `Default` task, which depends on `Test`. + +Test results land at `out/testResults.xml` (JUnitXml). PSScriptAnalyzer failures at `Error` severity fail the build. + +## Agent skills + +### Issue tracker + +Issues live in GitHub Issues (PowerShellOrg/PSKoans) via the `gh` CLI. See `docs/agents/issue-tracker.md`. + +### Triage labels + +Default five-role vocabulary (`needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human`, `wontfix`). See `docs/agents/triage-labels.md`. + +### Domain docs + +Single-context — `CONTEXT.md` + `docs/adr/` at the repo root. See `docs/agents/domain.md`. diff --git a/CONTEXT.md b/CONTEXT.md new file mode 100644 index 00000000..4c69b0e0 --- /dev/null +++ b/CONTEXT.md @@ -0,0 +1,51 @@ +# PSKoans + +A PowerShell learning framework, structured as a set of guided exercises ("koans") that teach the language by making failing tests pass. + +## Language + +### Core learning loop + +**Koan**: +A single named Pester `It` test representing one question. The learner makes it pass by replacing its Blank(s) with the correct value or expression. +_Avoid_: exercise, question, test (unqualified) + +**Blank**: +The placeholder token (`__`, `____`, `$____`, `'____'`) inside a Koan that the learner must replace to make it pass. Also the name of the `[Blank]` sentinel class used as the default value in some koans — every comparison against it fails until replaced. +_Avoid_: placeholder, stub + +**Karma**: +The learner's aggregate progress: the count of Koans passed versus the total, across whatever scope was requested. Computed by running the Koans through Pester and reported by `Get-Karma` / `Show-Karma`. +_Avoid_: score, progress (unqualified) + +**Meditation** / **Meditation Prompt**: +The console report `Show-Karma` displays after evaluating Karma: either the next failing Koan's context (Describe/It names, expectation, current line) or a completion message. +_Avoid_: results, report + +### Content organization + +**Topic**: +A `*.Koans.ps1` file holding a themed set of Koans (e.g. `AboutArrays`, `AboutComparison`). Identified by its base filename and tagged with a `[Koan(...)]` attribute. +_Avoid_: koan file, lesson, chapter + +**Kata**: +An advanced Topic (under `Koans/Katas`) that applies several concepts together in a realistic problem, as opposed to the single-concept introductory Topics. +_Avoid_: exercise, challenge + +**Module** (koan grouping): +A named grouping of Topics scoped to a third-party PowerShell module (e.g. `ActiveDirectory`, `dbatools`), stored under `Koans/Modules/`. The core, always-present Topics live in the reserved `_powershell` module. +_Avoid_: unqualified "module" when a real PowerShell module is meant — this repo overloads the word deliberately (`Get-PSKoan -Module ActiveDirectory`); qualify explicitly ("koan module" vs. "PowerShell module") when ambiguous. + +**Position**: +The ordering value (`[Koan(Position = ...)]`) on a Topic file that controls where it falls in the learner's progression sequence within its Module. +_Avoid_: order, index + +### Progress & environment + +**Koan Library** / **Koan Location**: +The learner's local, mutable copy of Topic files (path returned by `Get-PSKoanLocation`), edited in place to solve Koans. Distinct from the module's own canonical copy, which `Update-PSKoan` and `Reset-PSKoan` treat as the source of truth. +_Avoid_: koans folder (ambiguous between the two copies) + +**Advice**: +A short, standalone motivational or informational tip (stored as `*.Advice.json`), shown by `Show-Advice` / `Register-Advice` on session start. Unrelated to Koan content or progress. +_Avoid_: tip, hint (hint risks confusion with in-koan guidance) diff --git a/docs/agents/domain.md b/docs/agents/domain.md new file mode 100644 index 00000000..edc1da9a --- /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 `/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 (this repo): + +``` +/ +├── 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 `/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 00000000..bf595e24 --- /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 00000000..7d1dc6ab --- /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.