@heihei0299/matt-skills 1.3.1 → 1.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agents/skills/ask-matt/PHASE-BOUNDARIES.md +55 -0
- package/.agents/skills/ask-matt/SKILL.md +37 -25
- package/.agents/skills/ci-guard/SKILL.md +104 -0
- package/.agents/skills/ci-guard/agents/openai.yaml +5 -0
- package/.agents/skills/code-review/SKILL.md +28 -35
- package/.agents/skills/codebase-design/DEEPENING.md +4 -4
- package/.agents/skills/codebase-design/DESIGN-IT-TWICE.md +10 -10
- package/.agents/skills/codebase-design/SKILL.md +13 -13
- package/.agents/skills/diagnosing-bugs/SKILL.md +34 -30
- package/.agents/skills/diagnosing-bugs/scripts/hitl-loop.template.sh +3 -0
- package/.agents/skills/domain-modeling/ADR-FORMAT.md +11 -11
- package/.agents/skills/domain-modeling/CONTEXT-FORMAT.md +3 -3
- package/.agents/skills/domain-modeling/SKILL.md +10 -10
- package/.agents/skills/grill-me/SKILL.md +1 -1
- package/.agents/skills/grill-with-docs/SKILL.md +1 -1
- package/.agents/skills/grilling/SKILL.md +20 -4
- package/.agents/skills/grilling/agents/openai.yaml +1 -1
- package/.agents/skills/handoff/SKILL.md +1 -1
- package/.agents/skills/improve-codebase-architecture/HTML-REPORT.md +19 -19
- package/.agents/skills/improve-codebase-architecture/SKILL.md +21 -21
- package/.agents/skills/instance-test/SKILL.md +36 -27
- package/.agents/skills/instance-test/agents/openai.yaml +1 -1
- package/.agents/skills/instance-test/references/instances.md +63 -36
- package/.agents/skills/prototype/LOGIC.md +30 -42
- package/.agents/skills/prototype/SKILL.md +7 -7
- package/.agents/skills/prototype/UI.md +23 -23
- package/.agents/skills/research/SKILL.md +1 -1
- package/.agents/skills/resolving-merge-conflicts/SKILL.md +1 -1
- package/.agents/skills/scaffold-functional-test/SKILL.md +77 -0
- package/.agents/skills/scaffold-functional-test/agents/openai.yaml +5 -0
- package/.agents/skills/setup-matt-pocock-skills/SKILL.md +30 -30
- package/.agents/skills/setup-matt-pocock-skills/domain.md +4 -4
- package/.agents/skills/setup-matt-pocock-skills/issue-tracker-github.md +5 -5
- package/.agents/skills/setup-matt-pocock-skills/issue-tracker-gitlab.md +6 -6
- package/.agents/skills/setup-matt-pocock-skills/issue-tracker-local.md +3 -3
- package/.agents/skills/tdd/SKILL.md +9 -7
- package/.agents/skills/teach/GLOSSARY-FORMAT.md +3 -3
- package/.agents/skills/teach/LEARNING-RECORD-FORMAT.md +10 -10
- package/.agents/skills/teach/MISSION-FORMAT.md +4 -4
- package/.agents/skills/teach/RESOURCES-FORMAT.md +2 -2
- package/.agents/skills/teach/SKILL.md +4 -4
- package/.agents/skills/to-questionnaire/SKILL.md +54 -0
- package/.agents/skills/to-questionnaire/agents/openai.yaml +5 -0
- package/.agents/skills/to-spec/SKILL.md +4 -4
- package/.agents/skills/to-tickets/SKILL.md +16 -16
- package/.agents/skills/triage/AGENT-BRIEF.md +9 -9
- package/.agents/skills/triage/OUT-OF-SCOPE.md +15 -15
- package/.agents/skills/triage/SKILL.md +29 -29
- package/.agents/skills/wait-what/SKILL.md +7 -0
- package/.agents/skills/wait-what/agents/openai.yaml +5 -0
- package/.agents/skills/wayfinder/SKILL.md +37 -37
- package/.agents/skills/wizard/SKILL.md +44 -0
- package/.agents/skills/wizard/agents/openai.yaml +3 -0
- package/.agents/skills/wizard/template.sh +204 -0
- package/.agents/skills/writing-for-agents/SKILL-MECHANICS.md +22 -0
- package/.agents/skills/writing-for-agents/SKILL.md +81 -0
- package/.agents/skills/writing-for-agents/agents/openai.yaml +3 -0
- package/README.md +9 -9
- package/bin/cli.js +1 -1
- package/config/proprietary.json +8 -1
- package/package.json +1 -1
- package/scripts/sync-upstream.js +1 -1
- package/template/.opencode/CONTEXT.md +2 -2
- package/template/.opencode/commands/{writing-great-skills.md → writing-for-agents.md} +1 -1
- package/template/.opencode/docs/agents/skill-design.md +3 -3
- package/template/.opencode/skills/ci-guard/SKILL.md +104 -0
- package/template/.opencode/skills/ci-guard/agents/openai.yaml +5 -0
- package/template/.opencode/skills/scaffold-functional-test/SKILL.md +77 -0
- package/template/.opencode/skills/scaffold-functional-test/agents/openai.yaml +5 -0
- package/template/.pi/CONTEXT.md +55 -0
- package/template/.pi/docs/agents/runtime-discipline.md +3 -2
- package/template/.pi/docs/agents/skill-design.md +10 -5
- package/template/.pi/skills/ci-guard/SKILL.md +104 -0
- package/template/.pi/skills/ci-guard/agents/openai.yaml +5 -0
- package/template/.pi/skills/scaffold-functional-test/SKILL.md +77 -0
- package/template/.pi/skills/scaffold-functional-test/agents/openai.yaml +5 -0
- package/template/AGENTS.md +3 -4
- package/.agents/skills/writing-great-skills/GLOSSARY.md +0 -201
- package/.agents/skills/writing-great-skills/SKILL.md +0 -83
- package/.agents/skills/writing-great-skills/agents/openai.yaml +0 -5
- package/template/.opencode/skills/instance-test/SKILL.md +0 -61
- package/template/.opencode/skills/instance-test/agents/openai.yaml +0 -5
- package/template/.opencode/skills/instance-test/references/instances.md +0 -48
- package/template/.pi/skills/instance-test/SKILL.md +0 -61
- package/template/.pi/skills/instance-test/agents/openai.yaml +0 -5
- package/template/.pi/skills/instance-test/references/instances.md +0 -48
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: to-tickets
|
|
3
|
-
description: Break a plan, spec, or the current conversation into a set of tracer-bullet tickets, each declaring its blocking edges, published to the configured tracker
|
|
3
|
+
description: Break a plan, spec, or the current conversation into a set of tracer-bullet tickets, each declaring its blocking edges, published to the configured tracker (edges as text in one file per ticket locally, or native blocking links on a real tracker).
|
|
4
4
|
disable-model-invocation: true
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# To Tickets
|
|
8
8
|
|
|
9
|
-
Break a plan, spec, or conversation into a set of **tickets
|
|
9
|
+
Break a plan, spec, or conversation into a set of **tickets**: tracer-bullet vertical slices, each declaring the tickets that **block** it.
|
|
10
10
|
|
|
11
|
-
The issue tracker and triage label vocabulary should have been provided to you
|
|
11
|
+
The issue tracker and triage label vocabulary should have been provided to you. If not, tell the user to run `/setup-matt-pocock-skills`.
|
|
12
12
|
|
|
13
13
|
## Process
|
|
14
14
|
|
|
@@ -28,16 +28,16 @@ Break the work into **tracer bullet** tickets.
|
|
|
28
28
|
|
|
29
29
|
<vertical-slice-rules>
|
|
30
30
|
|
|
31
|
-
- Each slice cuts a narrow but COMPLETE path through every layer (schema, API, UI, tests)
|
|
31
|
+
- Each slice cuts a narrow but COMPLETE path through every layer (schema, API, UI, tests): vertical, NOT a horizontal slice of one layer
|
|
32
32
|
- A completed slice is demoable or verifiable on its own
|
|
33
33
|
- Each slice is sized to fit in a single fresh context window
|
|
34
34
|
- Any prefactoring should be done first
|
|
35
35
|
|
|
36
36
|
</vertical-slice-rules>
|
|
37
37
|
|
|
38
|
-
Give each ticket its **blocking edges
|
|
38
|
+
Give each ticket its **blocking edges**: the other tickets that must complete before it can start. A ticket with no blockers can start immediately.
|
|
39
39
|
|
|
40
|
-
**Wide refactors are the exception to vertical slicing.** A **wide refactor** is one mechanical change
|
|
40
|
+
**Wide refactors are the exception to vertical slicing.** A **wide refactor** is one mechanical change (rename a column, retype a shared symbol) whose **blast radius** fans across the whole codebase, so a single edit breaks thousands of call sites at once and no vertical slice can land green. Don't force it into a tracer bullet; sequence it as **expand–contract**. First expand: add the new form beside the old so nothing breaks. Then migrate the call sites over in batches sized by blast radius (per package, per directory), each batch its own ticket blocked by the expand, keeping CI green batch to batch because the old form still exists. Finally contract: delete the old form once no caller remains, in a ticket blocked by every migrate batch. When even the batches can't stay green alone, keep the sequence but let them share an integration branch that all block a final integrate-and-verify ticket; green is promised only there.
|
|
41
41
|
|
|
42
42
|
### 4. Quiz the user
|
|
43
43
|
|
|
@@ -50,17 +50,17 @@ Present the proposed breakdown as a numbered list. For each ticket, show:
|
|
|
50
50
|
Ask the user:
|
|
51
51
|
|
|
52
52
|
- Does the granularity feel right? (too coarse / too fine)
|
|
53
|
-
- Are the blocking edges correct
|
|
53
|
+
- Are the blocking edges correct: does each ticket only depend on tickets that genuinely gate it?
|
|
54
54
|
- Should any tickets be merged or split further?
|
|
55
55
|
|
|
56
56
|
Iterate until the user approves the breakdown.
|
|
57
57
|
|
|
58
58
|
### 5. Publish the tickets to the configured tracker
|
|
59
59
|
|
|
60
|
-
Publish the approved tickets. **How** depends on the tracker `/setup-matt-pocock-skills` configured
|
|
60
|
+
Publish the approved tickets. **How** depends on the tracker `/setup-matt-pocock-skills` configured; the tickets are the same either way, only the shape of the blocking edges changes:
|
|
61
61
|
|
|
62
|
-
- **Local files** → write one file per ticket under `.scratch/<feature-slug>/issues/<NN>-<slug>.md`, numbered from `01` in dependency order (blockers first). Each file's "Blocked by" lists the numbers/titles it depends on. Use the per-ticket file template below
|
|
63
|
-
- **A real issue tracker (GitHub, Linear, …)** → publish one issue per ticket in dependency order (blockers first) so each ticket's blocking edges can reference real identifiers. Use the platform's native blocking / sub-issue relationship where it has one; otherwise set each ticket's "Blocked by" to the blocking issues. Apply the `ready-for-agent` triage label unless instructed otherwise
|
|
62
|
+
- **Local files** → write one file per ticket under `.scratch/<feature-slug>/issues/<NN>-<slug>.md`, numbered from `01` in dependency order (blockers first). Each file's "Blocked by" lists the numbers/titles it depends on. Use the per-ticket file template below: one ticket per file, never a single combined file.
|
|
63
|
+
- **A real issue tracker (GitHub, Linear, …)** → publish one issue per ticket in dependency order (blockers first) so each ticket's blocking edges can reference real identifiers. Use the platform's native blocking / sub-issue relationship where it has one; otherwise set each ticket's "Blocked by" to the blocking issues. Apply the `ready-for-agent` triage label unless instructed otherwise; the tickets are agent-grabbable by construction.
|
|
64
64
|
|
|
65
65
|
Work the **frontier**: any ticket whose blockers are all done. For a purely linear chain that means top to bottom.
|
|
66
66
|
|
|
@@ -68,11 +68,11 @@ Do NOT close or modify any parent issue.
|
|
|
68
68
|
|
|
69
69
|
<local-ticket-template>
|
|
70
70
|
|
|
71
|
-
# <NN
|
|
71
|
+
# <NN>: <Ticket title>
|
|
72
72
|
|
|
73
|
-
**What to build:** the end-to-end behaviour this ticket makes work, from the user's perspective
|
|
73
|
+
**What to build:** the end-to-end behaviour this ticket makes work, from the user's perspective, not a layer-by-layer implementation list.
|
|
74
74
|
|
|
75
|
-
**Blocked by:** the numbers/titles of the tickets that gate this one, or "None
|
|
75
|
+
**Blocked by:** the numbers/titles of the tickets that gate this one, or "None (can start immediately)".
|
|
76
76
|
|
|
77
77
|
**Status:** ready-for-agent
|
|
78
78
|
|
|
@@ -89,7 +89,7 @@ A reference to the parent issue on the tracker (if the source was an existing is
|
|
|
89
89
|
|
|
90
90
|
## What to build
|
|
91
91
|
|
|
92
|
-
The end-to-end behaviour this ticket makes work, from the user's perspective
|
|
92
|
+
The end-to-end behaviour this ticket makes work, from the user's perspective, not layer-by-layer implementation.
|
|
93
93
|
|
|
94
94
|
## Acceptance criteria
|
|
95
95
|
|
|
@@ -98,8 +98,8 @@ The end-to-end behaviour this ticket makes work, from the user's perspective —
|
|
|
98
98
|
|
|
99
99
|
## Blocked by
|
|
100
100
|
|
|
101
|
-
- A reference to each blocking ticket, or "None
|
|
101
|
+
- A reference to each blocking ticket, or "None (can start immediately)".
|
|
102
102
|
|
|
103
103
|
</issue-template>
|
|
104
104
|
|
|
105
|
-
In either form, avoid specific file paths or code snippets
|
|
105
|
+
In either form, avoid specific file paths or code snippets: they go stale fast. Exception: if a prototype produced a snippet that encodes a decision more precisely than prose can (state machine, reducer, schema, type shape), inline it and note briefly that it came from a prototype. Trim to the decision-rich parts, not a working demo, just the important bits.
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Writing Agent Briefs
|
|
2
2
|
|
|
3
|
-
An agent brief is a structured comment posted on a GitHub issue or PR when it moves to `ready-for-agent`. It is the authoritative specification that an AFK agent will work from. The original body and discussion are context
|
|
3
|
+
An agent brief is a structured comment posted on a GitHub issue or PR when it moves to `ready-for-agent`. It is the authoritative specification that an AFK agent will work from. The original body and discussion are context: the agent brief is the contract.
|
|
4
4
|
|
|
5
|
-
The brief states **what the agent should do**, which stretches to both surfaces: for an issue, that's building the change from nothing; for a PR, it's what's left to do *to the existing diff
|
|
5
|
+
The brief states **what the agent should do**, which stretches to both surfaces: for an issue, that's building the change from nothing; for a PR, it's what's left to do *to the existing diff*: finish it, close gaps, address review points. Same principles either way; the PR example below shows the difference.
|
|
6
6
|
|
|
7
7
|
## Principles
|
|
8
8
|
|
|
@@ -12,7 +12,7 @@ The issue may sit in `ready-for-agent` for days or weeks. The codebase will chan
|
|
|
12
12
|
|
|
13
13
|
- **Do** describe interfaces, types, and behavioral contracts
|
|
14
14
|
- **Do** name specific types, function signatures, or config shapes that the agent should look for or modify
|
|
15
|
-
- **Don't** reference file paths
|
|
15
|
+
- **Don't** reference file paths: they go stale
|
|
16
16
|
- **Don't** reference line numbers
|
|
17
17
|
- **Don't** assume the current implementation structure will remain the same
|
|
18
18
|
|
|
@@ -53,9 +53,9 @@ Describe what should happen after the agent's work is complete.
|
|
|
53
53
|
Be specific about edge cases and error conditions.
|
|
54
54
|
|
|
55
55
|
**Key interfaces:**
|
|
56
|
-
- `TypeName
|
|
57
|
-
- `functionName()` return type
|
|
58
|
-
- Config shape
|
|
56
|
+
- `TypeName`: what needs to change and why
|
|
57
|
+
- `functionName()` return type: what it currently returns vs what it should return
|
|
58
|
+
- Config shape: any new configuration options needed
|
|
59
59
|
|
|
60
60
|
**Acceptance criteria:**
|
|
61
61
|
- [ ] Specific, testable criterion 1
|
|
@@ -87,7 +87,7 @@ Truncation should break at the last word boundary before 1024 characters
|
|
|
87
87
|
and append "..." to indicate truncation.
|
|
88
88
|
|
|
89
89
|
**Key interfaces:**
|
|
90
|
-
- The `SkillMetadata` type's `description` field
|
|
90
|
+
- The `SkillMetadata` type's `description` field: no type change needed,
|
|
91
91
|
but the validation/processing logic that populates it needs to respect
|
|
92
92
|
word boundaries
|
|
93
93
|
- Any function that reads SKILL.md frontmatter and extracts the description
|
|
@@ -125,7 +125,7 @@ requested the feature. When triaging new issues, these files should be
|
|
|
125
125
|
checked for matches.
|
|
126
126
|
|
|
127
127
|
**Key interfaces:**
|
|
128
|
-
- Markdown file format in `.out-of-scope
|
|
128
|
+
- Markdown file format in `.out-of-scope/`: each file should have a
|
|
129
129
|
`# Concept Name` heading, a `**Decision:**` line, a `**Reason:**` line,
|
|
130
130
|
and a `**Prior requests:**` list with issue links
|
|
131
131
|
- The triage workflow should read all `.out-of-scope/*.md` files early
|
|
@@ -162,7 +162,7 @@ remain: errors are still printed as human text (not JSON), and the new flag has
|
|
|
162
162
|
no test coverage.
|
|
163
163
|
|
|
164
164
|
**Desired behavior:**
|
|
165
|
-
With `--json`, all output
|
|
165
|
+
With `--json`, all output (including errors) is well-formed JSON on stdout,
|
|
166
166
|
and the command's exit codes are unchanged. The existing human-readable output
|
|
167
167
|
is untouched when the flag is absent.
|
|
168
168
|
|
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
The `.out-of-scope/` directory in a repo stores persistent records of rejected feature requests. It serves two purposes:
|
|
4
4
|
|
|
5
|
-
1. **Institutional memory
|
|
6
|
-
2. **Deduplication
|
|
5
|
+
1. **Institutional memory**: why a feature was rejected, so the reasoning isn't lost when the issue is closed
|
|
6
|
+
2. **Deduplication**: when a new issue comes in that matches a prior rejection, the skill can surface the previous decision instead of re-litigating it
|
|
7
7
|
|
|
8
8
|
## Directory structure
|
|
9
9
|
|
|
@@ -18,7 +18,7 @@ One file per **concept**, not per issue. Multiple issues requesting the same thi
|
|
|
18
18
|
|
|
19
19
|
## File format
|
|
20
20
|
|
|
21
|
-
The file should be written in a relaxed, readable style
|
|
21
|
+
The file should be written in a relaxed, readable style, more like a short design document than a database entry. Use paragraphs, code samples, and examples to make the reasoning clear and useful to someone encountering it for the first time.
|
|
22
22
|
|
|
23
23
|
```markdown
|
|
24
24
|
# Dark Mode
|
|
@@ -48,9 +48,9 @@ interface ThemeConfig {
|
|
|
48
48
|
|
|
49
49
|
## Prior requests
|
|
50
50
|
|
|
51
|
-
- #42
|
|
52
|
-
- #87
|
|
53
|
-
- #134
|
|
51
|
+
- #42: "Add dark mode support"
|
|
52
|
+
- #87: "Night theme for accessibility"
|
|
53
|
+
- #134: "Dark theme option"
|
|
54
54
|
```
|
|
55
55
|
|
|
56
56
|
### Naming the file
|
|
@@ -59,31 +59,31 @@ Use a short, descriptive kebab-case name for the concept: `dark-mode.md`, `plugi
|
|
|
59
59
|
|
|
60
60
|
### Writing the reason
|
|
61
61
|
|
|
62
|
-
The reason should be substantive
|
|
62
|
+
The reason should be substantive: not "we don't want this" but why. Good reasons reference:
|
|
63
63
|
|
|
64
64
|
- Project scope or philosophy ("This project focuses on X; theming is a downstream concern")
|
|
65
65
|
- Technical constraints ("Supporting this would require Y, which conflicts with our Z architecture")
|
|
66
66
|
- Strategic decisions ("We chose to use A instead of B because...")
|
|
67
67
|
|
|
68
|
-
The reason should be durable. Avoid referencing temporary circumstances ("we're too busy right now")
|
|
68
|
+
The reason should be durable. Avoid referencing temporary circumstances ("we're too busy right now"); those aren't real rejections, they're deferrals.
|
|
69
69
|
|
|
70
70
|
## When to check `.out-of-scope/`
|
|
71
71
|
|
|
72
72
|
During triage (Step 1: Gather context), read all files in `.out-of-scope/`. When evaluating a new issue:
|
|
73
73
|
|
|
74
74
|
- Check if the request matches an existing out-of-scope concept
|
|
75
|
-
- Matching is by concept similarity, not keyword
|
|
76
|
-
- If there's a match, surface it to the maintainer: "This is similar to `.out-of-scope/dark-mode.md
|
|
75
|
+
- Matching is by concept similarity, not keyword: "night theme" matches `dark-mode.md`
|
|
76
|
+
- If there's a match, surface it to the maintainer: "This is similar to `.out-of-scope/dark-mode.md`. We rejected this before because [reason]. Do you still feel the same way?"
|
|
77
77
|
|
|
78
78
|
The maintainer may:
|
|
79
79
|
|
|
80
|
-
- **Confirm
|
|
81
|
-
- **Reconsider
|
|
82
|
-
- **Disagree
|
|
80
|
+
- **Confirm**: the new issue gets added to the existing file's "Prior requests" list, then closed
|
|
81
|
+
- **Reconsider**: the out-of-scope file gets deleted or updated, and the issue proceeds through normal triage
|
|
82
|
+
- **Disagree**: the issues are related but distinct, proceed with normal triage
|
|
83
83
|
|
|
84
84
|
## When to write to `.out-of-scope/`
|
|
85
85
|
|
|
86
|
-
Only when an **enhancement** (not a bug) is *rejected* as `wontfix`. This applies to enhancement PRs exactly as it does to issues
|
|
86
|
+
Only when an **enhancement** (not a bug) is *rejected* as `wontfix`. This applies to enhancement PRs exactly as it does to issues: a rejected PR is recorded here so the same request doesn't return as fresh code.
|
|
87
87
|
|
|
88
88
|
Do **not** write here when something is closed as `wontfix` because it's **already implemented**. That's a built feature, not a rejected one; recording it would poison the dedup checks with false rejections. Instead, the closing comment points to where the feature already lives.
|
|
89
89
|
|
|
@@ -101,5 +101,5 @@ The flow:
|
|
|
101
101
|
If the maintainer changes their mind about a previously rejected concept:
|
|
102
102
|
|
|
103
103
|
- Delete the `.out-of-scope/` file
|
|
104
|
-
- The skill does not need to reopen old issues
|
|
104
|
+
- The skill does not need to reopen old issues; they're historical records
|
|
105
105
|
- The new issue that triggered the reconsideration proceeds through normal triage
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: triage
|
|
3
|
-
description: Move issues and external PRs through a state machine of triage roles
|
|
3
|
+
description: Move issues and external PRs through a state machine of triage roles, categorise, verify, grill if needed, and write agent-ready briefs.
|
|
4
4
|
disable-model-invocation: true
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -8,7 +8,7 @@ disable-model-invocation: true
|
|
|
8
8
|
|
|
9
9
|
Move issues on the project issue tracker through a small state machine of triage roles.
|
|
10
10
|
|
|
11
|
-
If this repo treats external pull requests as a request surface (see the issue-tracker config), triage covers them too: **a PR is an issue with attached code
|
|
11
|
+
If this repo treats external pull requests as a request surface (see the issue-tracker config), triage covers them too: **a PR is an issue with attached code**, using the same roles, same states, and same machine, with a few deltas marked "for a PR" below. Resolve a bare `#42` to an issue or PR per the tracker config.
|
|
12
12
|
|
|
13
13
|
Every comment or issue posted to the issue tracker during triage **must** start with this disclaimer:
|
|
14
14
|
|
|
@@ -18,31 +18,31 @@ Every comment or issue posted to the issue tracker during triage **must** start
|
|
|
18
18
|
|
|
19
19
|
## Reference docs
|
|
20
20
|
|
|
21
|
-
- [AGENT-BRIEF.md](AGENT-BRIEF.md)
|
|
22
|
-
- [OUT-OF-SCOPE.md](OUT-OF-SCOPE.md)
|
|
21
|
+
- [AGENT-BRIEF.md](AGENT-BRIEF.md): how to write durable agent briefs
|
|
22
|
+
- [OUT-OF-SCOPE.md](OUT-OF-SCOPE.md): how the `.out-of-scope/` knowledge base works
|
|
23
23
|
|
|
24
24
|
## Roles
|
|
25
25
|
|
|
26
26
|
Two **category** roles:
|
|
27
27
|
|
|
28
|
-
- `bug
|
|
29
|
-
- `enhancement
|
|
28
|
+
- `bug`: something is broken
|
|
29
|
+
- `enhancement`: new feature or improvement
|
|
30
30
|
|
|
31
31
|
Five **state** roles:
|
|
32
32
|
|
|
33
|
-
- `needs-triage
|
|
34
|
-
- `needs-info
|
|
35
|
-
- `ready-for-agent
|
|
36
|
-
- `ready-for-human
|
|
37
|
-
- `wontfix
|
|
33
|
+
- `needs-triage`: maintainer needs to evaluate
|
|
34
|
+
- `needs-info`: waiting on reporter for more information
|
|
35
|
+
- `ready-for-agent`: fully specified, ready for an AFK agent
|
|
36
|
+
- `ready-for-human`: needs human implementation
|
|
37
|
+
- `wontfix`: will not be actioned
|
|
38
38
|
|
|
39
39
|
For a PR, the same states read against the attached code: `ready-for-agent` means a brief is attached and an agent should take the next step on the diff; `ready-for-human` means it's ready for a human to merge.
|
|
40
40
|
|
|
41
41
|
Every triaged issue should carry exactly one category role and one state role. If state roles conflict, flag it and ask the maintainer before doing anything else.
|
|
42
42
|
|
|
43
|
-
These are canonical role names
|
|
43
|
+
These are canonical role names. The actual label strings used in the issue tracker may differ. The mapping should have been provided to you. If not, tell the user to run `/setup-matt-pocock-skills`.
|
|
44
44
|
|
|
45
|
-
State transitions: an unlabeled issue normally goes to `needs-triage` first; from there it moves to `needs-info`, `ready-for-agent`, `ready-for-human`, or `wontfix`. `needs-info` returns to `needs-triage` once the reporter replies. The maintainer can override at any time
|
|
45
|
+
State transitions: an unlabeled issue normally goes to `needs-triage` first; from there it moves to `needs-info`, `ready-for-agent`, `ready-for-human`, or `wontfix`. `needs-info` returns to `needs-triage` once the reporter replies. The maintainer can override at any time; flag transitions that look unusual and ask before proceeding.
|
|
46
46
|
|
|
47
47
|
## Invocation
|
|
48
48
|
|
|
@@ -57,33 +57,33 @@ The maintainer invokes `/triage` and describes what they want in natural languag
|
|
|
57
57
|
|
|
58
58
|
Query the issue tracker and present three buckets, oldest first:
|
|
59
59
|
|
|
60
|
-
1. **Unlabeled
|
|
61
|
-
2. **`needs-triage
|
|
62
|
-
3. **`needs-info` with reporter activity since the last triage notes
|
|
60
|
+
1. **Unlabeled**: never triaged.
|
|
61
|
+
2. **`needs-triage`**: evaluation in progress.
|
|
62
|
+
3. **`needs-info` with reporter activity since the last triage notes**: needs re-evaluation.
|
|
63
63
|
|
|
64
|
-
When PRs are in scope, include external PRs in these buckets and tag each line `[PR]` or `[issue]`. Discovery surfaces only *external* PRs (the tracker config defines who counts as external)
|
|
64
|
+
When PRs are in scope, include external PRs in these buckets and tag each line `[PR]` or `[issue]`. Discovery surfaces only *external* PRs (the tracker config defines who counts as external), so a collaborator's in-flight PR is not triage work. This filter is discovery-only; an explicitly named PR is always triaged regardless of author.
|
|
65
65
|
|
|
66
66
|
Show counts and a one-line summary per item. Let the maintainer pick.
|
|
67
67
|
|
|
68
68
|
## Triage a specific issue or PR
|
|
69
69
|
|
|
70
|
-
1. **Gather context.** Read the full issue or PR (body, comments, labels, author, dates; for a PR, the diff too). Parse any prior triage notes so you don't re-ask resolved questions. Explore the codebase using the project's domain glossary, respecting ADRs in the area. Run two checks against the codebase: (a) **redundancy
|
|
70
|
+
1. **Gather context.** Read the full issue or PR (body, comments, labels, author, dates; for a PR, the diff too). Parse any prior triage notes so you don't re-ask resolved questions. Explore the codebase using the project's domain glossary, respecting ADRs in the area. Run two checks against the codebase: (a) **redundancy**: search for an existing implementation of the requested behavior by domain concept (not just the request's wording), and report where you looked. If found, it's an already-implemented `wontfix` (step 5). (b) **prior rejection**: read `.out-of-scope/*.md` and surface any that resembles this request.
|
|
71
71
|
|
|
72
|
-
2. **Recommend.** Tell the maintainer your category and state recommendation with reasoning, plus a brief codebase summary relevant to the request
|
|
72
|
+
2. **Recommend.** Tell the maintainer your category and state recommendation with reasoning, plus a brief codebase summary relevant to the request (including whether it's already implemented). Wait for direction.
|
|
73
73
|
|
|
74
|
-
3. **Verify the claim.** Before any grilling, check that the claim holds up. For a bug, reproduce it from the reporter's steps. For a PR, confirm the diff does what it claims
|
|
74
|
+
3. **Verify the claim.** Before any grilling, check that the claim holds up. For a bug, reproduce it from the reporter's steps. For a PR, confirm the diff does what it claims: check it out, run the relevant tests or commands. Report what happened: confirmed (with code path), failed, or insufficient detail (a strong `needs-info` signal). A confirmed verification makes a much stronger agent brief.
|
|
75
75
|
|
|
76
|
-
4. **Grill (if needed).** If the request needs fleshing out,
|
|
76
|
+
4. **Grill (if needed).** If the request needs fleshing out, call the Skill tool twice, for "grilling" and "domain-modeling", and grill it into shape a round of questions at a time, sharpening domain terms and updating `CONTEXT.md`/ADRs inline as decisions land.
|
|
77
77
|
|
|
78
78
|
5. **Apply the outcome:**
|
|
79
|
-
- `ready-for-agent
|
|
80
|
-
- `ready-for-human
|
|
81
|
-
- `needs-info
|
|
82
|
-
- `wontfix
|
|
83
|
-
- **Already implemented
|
|
84
|
-
- **Rejected (bug)
|
|
85
|
-
- **Rejected (enhancement)
|
|
86
|
-
- `needs-triage
|
|
79
|
+
- `ready-for-agent`: post an agent brief comment ([AGENT-BRIEF.md](AGENT-BRIEF.md)).
|
|
80
|
+
- `ready-for-human`: same structure as an agent brief, but note why it can't be delegated (judgment calls, external access, design decisions, manual testing).
|
|
81
|
+
- `needs-info`: post triage notes (template below).
|
|
82
|
+
- For `wontfix`, close the issue, with the comment depending on *why*:
|
|
83
|
+
- **Already implemented**: the change already exists in the codebase. Point to where it lives; do **not** write to `.out-of-scope/` (that KB is for *rejected* requests, not built ones).
|
|
84
|
+
- **Rejected (bug)**: give a polite explanation, then close.
|
|
85
|
+
- **Rejected (enhancement)**: write to `.out-of-scope/`, link to it from a comment, then close ([OUT-OF-SCOPE.md](OUT-OF-SCOPE.md)).
|
|
86
|
+
- `needs-triage`: apply the role. Optional comment if there's partial progress.
|
|
87
87
|
|
|
88
88
|
## Quick state override
|
|
89
89
|
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: wait-what
|
|
3
|
+
description: "Stop. That last message did not land: re-pitch it."
|
|
4
|
+
disable-model-invocation: true
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Wait, I don't understand where you've got to here. Re-pitch that: give me a little bit of context, talk in ASD-STE100 Simplified Technical English, and use the ubiquitous language from `CONTEXT.md` (follow `CONTEXT-MAP.md` to the right one if the repo has more than one).
|
|
@@ -1,37 +1,37 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: wayfinder
|
|
3
|
-
description: Plan a huge chunk of work
|
|
3
|
+
description: Plan a huge chunk of work (more than one agent session can hold) as a shared map of decision tickets on your issue tracker, and resolve them one at a time until the way to the destination is clear.
|
|
4
4
|
disable-model-invocation: true
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
A loose idea has arrived
|
|
7
|
+
A loose idea has arrived, too big for one agent session, and wrapped in fog: the way from here to the **destination** isn't visible yet. Wayfinding is about finding that way, not charging at the destination. This skill charts the way as a **shared map** on the repo's issue tracker, then works its **decision tickets** (questions whose resolution is a decision, not slices of a build to execute) one at a time until the route is clear.
|
|
8
8
|
|
|
9
|
-
The destination varies per effort, and naming it is the first act of charting
|
|
9
|
+
The destination varies per effort, and naming it is the first act of charting: it shapes every ticket. It might be a spec to hand off and iterate on, a decision to lock before planning starts, or a change made in place like a data-structure migration. The map is domain-agnostic: engineering work, course content, whatever fits the shape.
|
|
10
10
|
|
|
11
11
|
## Plan, don't do
|
|
12
12
|
|
|
13
|
-
Wayfinder is **planning** by default: each ticket resolves a decision, and the map is done when the way is clear
|
|
13
|
+
Wayfinder is **planning** by default: each ticket resolves a decision, and the map is done when the way is clear, with nothing left to decide before someone goes and does the thing. The pull to just do the work is usually the signal you've reached the edge of the map and it's time to hand off. An effort can override this in its **Notes**, carrying execution into the map itself, but absent that, produce decisions, not deliverables.
|
|
14
14
|
|
|
15
15
|
## Refer by name
|
|
16
16
|
|
|
17
|
-
Every map and ticket is an issue, so it has a **name
|
|
17
|
+
Every map and ticket is an issue, so it has a **name**: its title. In everything the human reads (narration, the map's Decisions-so-far), refer to it by that name, never by a bare id, number, or slug. A wall of `#42, #43, #44` is illegible; names read at a glance. The id and URL don't vanish; a name wraps its link, but they ride _inside_ the name, never stand in for it.
|
|
18
18
|
|
|
19
19
|
## The Map
|
|
20
20
|
|
|
21
|
-
The map is a single issue on this repo's issue tracker, labelled `wayfinder:map
|
|
21
|
+
The map is a single issue on this repo's issue tracker, labelled `wayfinder:map`, the canonical artifact. Its tickets are child issues of the map.
|
|
22
22
|
|
|
23
|
-
The map is an **index**, not a store. It lists the decisions made and points at the tickets that hold their detail; a decision lives in exactly one place
|
|
23
|
+
The map is an **index**, not a store. It lists the decisions made and points at the tickets that hold their detail; a decision lives in exactly one place, its ticket, so the map never restates it, only gists it and links.
|
|
24
24
|
|
|
25
|
-
**Where the map, its child tickets, blocking, and frontier queries physically live is tracker-specific.** The issue tracker should have been provided to you
|
|
25
|
+
**Where the map, its child tickets, blocking, and frontier queries physically live is tracker-specific.** The issue tracker should have been provided to you. If not, tell the user to run `/setup-matt-pocock-skills`. Consult the tracker doc's "Wayfinding operations" section for how _this_ repo expresses them. If no tracker has been provided, default to the local-markdown tracker.
|
|
26
26
|
|
|
27
27
|
### The map body
|
|
28
28
|
|
|
29
|
-
The whole map at low resolution, loaded once per session. Open tickets are **not** listed
|
|
29
|
+
The whole map at low resolution, loaded once per session. Open tickets are **not** listed: they are open child issues, found by query.
|
|
30
30
|
|
|
31
31
|
```markdown
|
|
32
32
|
## Destination
|
|
33
33
|
|
|
34
|
-
<what reaching the end of this map looks like
|
|
34
|
+
<what reaching the end of this map looks like: the spec, decision, or change this effort is finding its way to. One or two lines; every session orients to it before choosing a ticket.>
|
|
35
35
|
|
|
36
36
|
## Notes
|
|
37
37
|
|
|
@@ -39,9 +39,9 @@ The whole map at low resolution, loaded once per session. Open tickets are **not
|
|
|
39
39
|
|
|
40
40
|
## Decisions so far
|
|
41
41
|
|
|
42
|
-
<!-- the index
|
|
42
|
+
<!-- the index: one line per closed ticket, enough to judge relevance, then zoom the link for the detail the ticket holds -->
|
|
43
43
|
|
|
44
|
-
- [<closed ticket title>](link)
|
|
44
|
+
- [<closed ticket title>](link): <one-line gist of the answer>
|
|
45
45
|
|
|
46
46
|
## Not yet specified
|
|
47
47
|
|
|
@@ -62,67 +62,67 @@ Each ticket is a **child issue** of the map; the tracker's issue id is its ident
|
|
|
62
62
|
<the decision or investigation this ticket resolves>
|
|
63
63
|
```
|
|
64
64
|
|
|
65
|
-
Each ticket carries a `wayfinder:<type>` label
|
|
65
|
+
Each ticket carries a `wayfinder:<type>` label, one of `research`, `prototype`, `grilling`, `task` (see [Ticket Types](#ticket-types)).
|
|
66
66
|
|
|
67
67
|
A session **claims** a ticket by assigning it to the dev driving the map, **first**, before any work, so concurrent sessions skip it. That assignee _is_ the claim: an open, unassigned ticket is unclaimed.
|
|
68
68
|
|
|
69
|
-
Blocking uses the tracker's **native** dependency relationship
|
|
69
|
+
Blocking uses the tracker's **native** dependency relationship: essential because it renders the frontier _visually_ in the tracker's own UI, so the human sees what's takeable without opening the map. Only a tracker that lacks native blocking falls back to a body convention. A ticket is **unblocked** when every ticket blocking it is closed; the **frontier** is the open, unblocked, unclaimed children, the edge of the known.
|
|
70
70
|
|
|
71
|
-
The answer isn't part of the body
|
|
71
|
+
The answer isn't part of the body; it's recorded on resolution (see [Work through the map](#work-through-the-map)). Assets created while resolving a ticket are linked from the issue, not pasted in.
|
|
72
72
|
|
|
73
73
|
## Ticket Types
|
|
74
74
|
|
|
75
|
-
Every ticket is either **HITL**
|
|
75
|
+
Every ticket is either **HITL** (human in the loop, worked _with_ a human who speaks for themselves) or **AFK**, driven by the agent alone. A HITL ticket only resolves through that live exchange; the agent never stands in for the human's side of it (a grilling agent that answers its own questions has broken this).
|
|
76
76
|
|
|
77
|
-
- **Research** (AFK): Reading documentation, third-party APIs, or local resources like knowledge bases to surface a fact a decision waits on. Resolved by a
|
|
78
|
-
- **Prototype** (HITL): Raise the fidelity of the discussion by making a cheap, rough, concrete artifact to react to
|
|
79
|
-
- **Grilling** (HITL): Conversation
|
|
80
|
-
- **Task** (HITL or AFK): Manual work that must happen before a
|
|
77
|
+
- **Research** (AFK): Reading documentation, third-party APIs, or local resources like knowledge bases to surface a fact a decision waits on. Resolved by a subagent that calls the Skill tool with "research". Use when knowledge outside the current working directory is required.
|
|
78
|
+
- **Prototype** (HITL): Raise the fidelity of the discussion by making a cheap, rough, concrete artifact to react to (an outline, a rough take, a stub, or UI/logic code) by calling the Skill tool with "prototype". Links the prototype as an asset. Use when "how should it look" or "how should it behave" is the key question.
|
|
79
|
+
- **Grilling** (HITL): Conversation. The default case. Always call the Skill tool twice, for "grilling" and "domain-modeling".
|
|
80
|
+
- **Task** (HITL or AFK): Manual work that must happen before a _decision_ can be made: nothing to decide, prototype, or research, but the discussion is blocked until it's done. Signing up for a service so its API can be judged, provisioning access, moving data so its shape can be seen. This is the one type that _does_ rather than decides, and it earns its place by unblocking a decision, not by delivering the destination. The agent drives it alone where it can (AFK); otherwise it hands the human a precise checklist (HITL). Resolved when the work is done; the answer records what was done and any resulting facts (credentials location, new URLs, row counts) later tickets depend on.
|
|
81
81
|
|
|
82
82
|
## Fog of war
|
|
83
83
|
|
|
84
|
-
The map is _deliberately_ incomplete: don't chart what you can't yet see. Beyond the live tickets lies the **fog of war
|
|
84
|
+
The map is _deliberately_ incomplete: don't chart what you can't yet see. Beyond the live tickets lies the **fog of war**: the dim view of decisions and investigations you can tell are coming but can't yet pin down, because they hang on questions still open. Resolving a ticket clears the fog ahead of it, graduating whatever's now specifiable into fresh tickets, one at a time, until the way to the destination is clear and no tickets remain.
|
|
85
85
|
|
|
86
|
-
The map's **Not yet specified** section is where that dim view is written down: the suspected question, the area to revisit later. It's the undiscovered frontier _toward_ the destination
|
|
86
|
+
The map's **Not yet specified** section is where that dim view is written down: the suspected question, the area to revisit later. It's the undiscovered frontier _toward_ the destination: everything here is in scope, just not sharp enough to ticket. Write as loosely or as fully as the view allows; it doubles as a signpost for collaborators reading where the effort is headed.
|
|
87
87
|
|
|
88
|
-
**Fog or ticket?** The test is whether you can state the question precisely now
|
|
88
|
+
**Fog or ticket?** The test is whether you can state the question precisely now, _not_ whether you can answer it now.
|
|
89
89
|
|
|
90
|
-
- **Ticket when** the question is already sharp
|
|
90
|
+
- **Ticket when** the question is already sharp, even if it's blocked and you can't act on it yet.
|
|
91
91
|
- **Not yet specified when** you can't yet phrase it that sharply. Don't pre-slice the fog into ticket-sized pieces: it's coarser than a ticket, and one patch may graduate into several tickets, or none, once the frontier reaches it.
|
|
92
92
|
|
|
93
93
|
**Not yet specified** excludes what's already decided (Decisions so far), what's already a live ticket, and what's out of scope (the next section).
|
|
94
94
|
|
|
95
95
|
## Out of scope
|
|
96
96
|
|
|
97
|
-
Fog only ever gathers _toward_ the destination. The destination fixes the scope, so work beyond it is **out of scope
|
|
97
|
+
Fog only ever gathers _toward_ the destination. The destination fixes the scope, so work beyond it is **out of scope**: it isn't fog, and it doesn't belong in **Not yet specified**. It gets its own **Out of scope** section on the map: work you've consciously ruled out of _this_ effort. Scope, not sharpness, lands it here.
|
|
98
98
|
|
|
99
|
-
Out-of-scope work never graduates
|
|
99
|
+
Out-of-scope work never graduates (the frontier stops at the destination), so it returns only if the destination is redrawn, and then as a fresh effort, not a resumption.
|
|
100
100
|
|
|
101
|
-
Ruling something out of scope is a scoping act, not a step on the route. When a ticket that already exists turns out to sit past the destination
|
|
101
|
+
Ruling something out of scope is a scoping act, not a step on the route. When a ticket that already exists turns out to sit past the destination (mis-scoped in while charting, or exposed by a resolution), **close it** (a closed ticket is unambiguously off the frontier) and leave one line in the **Out of scope** section: the gist plus why it's out of scope, linking the closed ticket. It stays out of **Decisions so far**, which records the route actually walked; a scope boundary isn't a step on it.
|
|
102
102
|
|
|
103
103
|
## Invocation
|
|
104
104
|
|
|
105
|
-
Two modes. Either way, **never resolve more than one ticket per session
|
|
105
|
+
Two modes. Either way, **never resolve more than one ticket per session**, with the exception of research tickets.
|
|
106
106
|
|
|
107
107
|
### Chart the map
|
|
108
108
|
|
|
109
109
|
User invokes with a loose idea.
|
|
110
110
|
|
|
111
|
-
1. **Name the destination.**
|
|
112
|
-
2. **Map the frontier.** Grill again, **breadth-first** this time: fan out across the whole space rather than deep on any one thread, surfacing the open decisions and the first steps takeable now. **If this surfaces no fog**
|
|
111
|
+
1. **Name the destination.** Call the Skill tool twice, for "grilling" and "domain-modeling", to pin down what this map is finding its way to: the spec, decision, or change. The destination fixes the scope, so it's settled first.
|
|
112
|
+
2. **Map the frontier.** Grill again, **breadth-first** this time: fan out across the whole space rather than deep on any one thread, surfacing the open decisions and the first steps takeable now. **If this surfaces no fog** (the way to the destination is already clear, the whole journey small enough for one session), you don't need a map. Stop and ask the user how they'd like to proceed.
|
|
113
113
|
3. **Create the map** (label `wayfinder:map`): Destination and Notes filled in, Decisions-so-far empty, the fog sketched into **Not yet specified**.
|
|
114
|
-
4. **Create the tickets you can specify now** as child issues of the map
|
|
115
|
-
5. **Fire the research subagents.** For each `research` ticket you just created, spin up a
|
|
116
|
-
6. Stop
|
|
114
|
+
4. **Create the tickets you can specify now** as child issues of the map, then wire blocking edges in a **second pass** (issues need ids before they can reference each other). Wiring sorts them into the frontier and the blocked; everything you can't yet specify stays in the fog: the **Not yet specified** section.
|
|
115
|
+
5. **Fire the research subagents.** For each `research` ticket you just created, spin up a subagent that calls the Skill tool with "research" to resolve it in parallel, capturing its findings on a throwaway `research/<name>` branch with a context pointer from the ticket.
|
|
116
|
+
6. Stop: charting is one session's work; it hand-resolves nothing.
|
|
117
117
|
|
|
118
118
|
### Work through the map
|
|
119
119
|
|
|
120
|
-
User invokes with a map (URL or number). A ticket is **optional
|
|
120
|
+
User invokes with a map (URL or number). A ticket is **optional**: without one, you pick the next decision, not the user.
|
|
121
121
|
|
|
122
|
-
1. Load the **map
|
|
122
|
+
1. Load the **map**: the low-res view, not every ticket body.
|
|
123
123
|
2. Choose the ticket. If the user named one, use it. Otherwise take the first frontier ticket in order. **Claim it**: assign it to yourself before any work.
|
|
124
|
-
3. Resolve it
|
|
124
|
+
3. Resolve it. **Zoom as needed**: fetch the full body of any related or closed ticket on demand; call the Skill tool for whichever skills the `## Notes` block names. If in doubt, call the Skill tool twice, for "grilling" and "domain-modeling".
|
|
125
125
|
4. Record the resolution: post the answer as a **resolution comment**, **close** the issue, and **append a context pointer** to the map's Decisions-so-far.
|
|
126
|
-
5. Add newly-surfaced tickets (create-then-wire); graduate any fog the answer has made specifiable, clearing each graduated patch from **Not yet specified** so it lives only as its new ticket. If the answer reveals a ticket
|
|
126
|
+
5. Add newly-surfaced tickets (create-then-wire); graduate any fog the answer has made specifiable, clearing each graduated patch from **Not yet specified** so it lives only as its new ticket. If the answer reveals that a ticket (this one or another) sits beyond the destination, **rule it out of scope** rather than resolving it on the route. If the decision invalidates other parts of the map, update or delete those tickets.
|
|
127
127
|
|
|
128
128
|
The user may run unblocked tickets in parallel, so expect other sessions to be editing the tracker concurrently.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: wizard
|
|
3
|
+
description: Generate an interactive bash wizard that walks a human through steps only they can perform. Use when provisioning infrastructure, setting up credentials or CI secrets, walking an unfamiliar third-party dashboard, or running a one-off migration or cutover. Don't invoke this for steps the agent can perform itself.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Wizard
|
|
7
|
+
|
|
8
|
+
A **wizard** is a bash script that walks a human, step by step, through a manual procedure that's tedious to do by hand and tedious to re-explain to an AI every time. It opens each URL, says exactly what to click and copy, captures the values, writes them where they belong (`.env`, GitHub secrets), confirms at every stage, and shows how many stages are left. It might configure third-party services, run a one-off migration, or move the project from one state to another.
|
|
9
|
+
|
|
10
|
+
The delightful UX is already solved by [template.sh](template.sh): stage-by-stage progress, confirmation gates, cross-platform URL opening (including WSL), hidden secret entry, idempotent `.env` upserts, `gh secret`/`gh variable` writes, and a closing summary. **Your job is only to scope the procedure and author its stages.** The library above the `STAGES` marker is identical in every wizard; that consistency is the point: never hand-edit it.
|
|
11
|
+
|
|
12
|
+
A wizard is ephemeral by default: built for one run, saved to a scratch or `scripts/` path, deleted when the job's done. Commit it only when the user wants a repeatable setup path that should live in the repo.
|
|
13
|
+
|
|
14
|
+
## Process
|
|
15
|
+
|
|
16
|
+
### 1. Scope the procedure
|
|
17
|
+
|
|
18
|
+
Work out every manual step the human must take and every value that gets captured along the way. Read the repo first, don't ask cold:
|
|
19
|
+
|
|
20
|
+
- For setup: `.env`, `.env.example`, `.env.*`, `README`, `docker-compose*`, framework config, and `.github/workflows/*` (every `secrets.*` / `vars.*` reference is a value the wizard must produce).
|
|
21
|
+
- For a migration or transition: the current state, the target state, and the irreversible actions between them.
|
|
22
|
+
|
|
23
|
+
Then show the user the ordered list of stages and the values each produces, and confirm: they may add, drop, or reorder.
|
|
24
|
+
|
|
25
|
+
**Done when:** every stage is named in order, and for each captured value you know (a) where the human gets it, (b) where it's written (`.env`, a GitHub secret, both, or nowhere; some stages are pure actions), and (c) whether it's secret (hidden entry) or public.
|
|
26
|
+
|
|
27
|
+
### 2. Map each stage's journey
|
|
28
|
+
|
|
29
|
+
For each stage, write the precise path a human follows: which URL to open, what to do there, where a value is shown, which variable it fills: e.g. "Dashboard → Developers → API keys → Reveal test key → copy". Where you don't actually know the current UI or the exact command, say so and ask the user or check the docs: never invent steps that may not exist.
|
|
30
|
+
|
|
31
|
+
**Done when:** every stage traces to concrete instructions a stranger could follow.
|
|
32
|
+
|
|
33
|
+
### 3. Author the wizard
|
|
34
|
+
|
|
35
|
+
Copy `template.sh` to the target path. Replace the example stage with one `stage` per step, in dependency order. Use the library helpers: `stage`, `say`/`step`, `open_url`, `ask`/`ask_secret`, `write_env`, `set_secret`/`set_var`, `pause`/`confirm`. Set `TOTAL_STAGES` to the number of stages you wrote.
|
|
36
|
+
|
|
37
|
+
Hold the bar the template sets: open the URL before asking for its value, use `ask_secret` for anything secret, `write_env` every persisted value, `set_secret` only the values CI actually needs, and `confirm` before any irreversible action. Each `stage` clears the screen so only the current step is visible: keep a stage to one focused task so nothing the human needs scrolls away. Don't touch the library above the marker.
|
|
38
|
+
|
|
39
|
+
### 4. Verify and hand off
|
|
40
|
+
|
|
41
|
+
- `bash -n <script>`; run `shellcheck` if available.
|
|
42
|
+
- `chmod +x <script>`.
|
|
43
|
+
- Don't run it end-to-end yourself: it opens browsers and blocks on human input. Trace it statically instead: every value from step 1 is captured and lands where step 1 said, and every `set_secret` name exactly matches a `secrets.*` reference in CI.
|
|
44
|
+
- Tell the user how to run it. If it's a repeatable setup path, commit it and link it from the README so the next person runs the script instead of asking an AI.
|