Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Build & test

Build is psake-driven via `build.ps1`, which wraps `psakeFile.ps1` (PowerShellBuild-based).

Check warning on line 3 in AGENTS.md

View workflow job for this annotation

GitHub Actions / ci / Run Linters

Unknown word (psake) Suggestions: (spake, sake, pase, spae, passe)

Check warning on line 3 in AGENTS.md

View workflow job for this annotation

GitHub Actions / ci / Run Linters

Unknown word (psake) Suggestions: (spake, sake, pase, spae, passe)

- 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`.
51 changes: 51 additions & 0 deletions CONTEXT.md
Original file line number Diff line number Diff line change
@@ -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**:

Check warning on line 31 in CONTEXT.md

View workflow job for this annotation

GitHub Actions / ci / Run Linters

Unknown word (Kata) Suggestions: (kaka, kama, Kama, kana, kara)
An advanced Topic (under `Koans/Katas`) that applies several concepts together in a realistic problem, as opposed to the single-concept introductory Topics.

Check warning on line 32 in CONTEXT.md

View workflow job for this annotation

GitHub Actions / ci / Run Linters

Unknown word (Katas) Suggestions: (kakas, kanas, katar, Katar, kavas)
_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/<Name>`. The core, always-present Topics live in the reserved `_powershell` module.

Check warning on line 36 in CONTEXT.md

View workflow job for this annotation

GitHub Actions / ci / Run Linters

Unknown word (dbatools) Suggestions: (devtools, diabolos, diatoms, devtool, diatom's)
_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)
36 changes: 36 additions & 0 deletions docs/agents/domain.md
Original file line number Diff line number Diff line change
@@ -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/<context>/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/
Comment on lines +20 to +23
```

## 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…_
45 changes: 45 additions & 0 deletions docs/agents/issue-tracker.md
Original file line number Diff line number Diff line change
@@ -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 <number> --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 <number> --body "..."`
- **Apply / remove labels**: `gh issue edit <number> --add-label "..."` / `--remove-label "..."`
- **Close**: `gh issue close <number> --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 <number> --comments` and `gh pr diff <number>` 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 <number> --comments`.

## Wayfinding operations

Check warning on line 36 in docs/agents/issue-tracker.md

View workflow job for this annotation

GitHub Actions / ci / Run Linters

Unknown word (Wayfinding) Suggestions: (wayfaring)

Used by `/wayfinder`. The **map** is a single issue with **child** issues as tickets.

Check warning on line 38 in docs/agents/issue-tracker.md

View workflow job for this annotation

GitHub Actions / ci / Run Linters

Unknown word (wayfinder) Suggestions: (wander, wayside, wayfarer, waysides, wharfinger)

- **Map**: a single issue labelled `wayfinder:map`, holding the Notes / Decisions-so-far / Fog body. `gh issue create --label wayfinder:map`.

Check warning on line 40 in docs/agents/issue-tracker.md

View workflow job for this annotation

GitHub Actions / ci / Run Linters

Unknown word (wayfinder) Suggestions: (wander, wayside, wayfarer, waysides, wharfinger)

Check warning on line 40 in docs/agents/issue-tracker.md

View workflow job for this annotation

GitHub Actions / ci / Run Linters

Unknown word (wayfinder) Suggestions: (wander, wayside, wayfarer, waysides, wharfinger)
- **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 #<map>` at the top of the child body. Labels: `wayfinder:<type>` (`research`/`prototype`/`grilling`/`task`). Once claimed, the ticket is assigned to the driving dev.

Check warning on line 41 in docs/agents/issue-tracker.md

View workflow job for this annotation

GitHub Actions / ci / Run Linters

Unknown word (wayfinder) Suggestions: (wander, wayside, wayfarer, waysides, wharfinger)
Comment on lines +40 to +41
- **Blocking**: GitHub's **native issue dependencies** — the canonical, UI-visible representation. Add an edge with `gh api --method POST repos/<owner>/<repo>/issues/<child>/dependencies/blocked_by -F issue_id=<blocker-db-id>`, where `<blocker-db-id>` is the blocker's numeric **database id** (`gh api repos/<owner>/<repo>/issues/<n> --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: #<n>, #<n>` 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 <n> --add-assignee @me` — the session's first write.
- **Resolve**: `gh issue comment <n> --body "<answer>"`, then `gh issue close <n>`, then append a context pointer (gist + link) to the map's Decisions-so-far.
15 changes: 15 additions & 0 deletions docs/agents/triage-labels.md
Original file line number Diff line number Diff line change
@@ -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 |
Comment on lines +9 to +10
| `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.
Loading