skilledagent 1.0.0

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.
Files changed (72) hide show
  1. package/.agents/AGENTS.MD +44 -0
  2. package/.agents/AGENTS_README.md +125 -0
  3. package/.agents/CONTEXT.md +19 -0
  4. package/.agents/skills/ask-matt/SKILL.md +76 -0
  5. package/.agents/skills/claude-handoff/SKILL.md +18 -0
  6. package/.agents/skills/code-review/SKILL.md +89 -0
  7. package/.agents/skills/codebase-design/DEEPENING.md +37 -0
  8. package/.agents/skills/codebase-design/DESIGN-IT-TWICE.md +44 -0
  9. package/.agents/skills/codebase-design/SKILL.md +114 -0
  10. package/.agents/skills/design-an-interface/SKILL.md +94 -0
  11. package/.agents/skills/diagnosing-bugs/SKILL.md +134 -0
  12. package/.agents/skills/diagnosing-bugs/scripts/hitl-loop.template.sh +41 -0
  13. package/.agents/skills/domain-modeling/ADR-FORMAT.md +47 -0
  14. package/.agents/skills/domain-modeling/CONTEXT-FORMAT.md +60 -0
  15. package/.agents/skills/domain-modeling/SKILL.md +74 -0
  16. package/.agents/skills/edit-article/SKILL.md +15 -0
  17. package/.agents/skills/git-guardrails-claude-code/SKILL.md +95 -0
  18. package/.agents/skills/git-guardrails-claude-code/scripts/block-dangerous-git.sh +25 -0
  19. package/.agents/skills/grill-me/SKILL.md +7 -0
  20. package/.agents/skills/grill-with-docs/SKILL.md +7 -0
  21. package/.agents/skills/grilling/SKILL.md +12 -0
  22. package/.agents/skills/handoff/SKILL.md +16 -0
  23. package/.agents/skills/implement/SKILL.md +15 -0
  24. package/.agents/skills/improve-codebase-architecture/HTML-REPORT.md +123 -0
  25. package/.agents/skills/improve-codebase-architecture/SKILL.md +66 -0
  26. package/.agents/skills/loop-me/SKILL.md +32 -0
  27. package/.agents/skills/migrate-to-shoehorn/SKILL.md +118 -0
  28. package/.agents/skills/obsidian-vault/SKILL.md +59 -0
  29. package/.agents/skills/prototype/LOGIC.md +79 -0
  30. package/.agents/skills/prototype/SKILL.md +26 -0
  31. package/.agents/skills/prototype/UI.md +112 -0
  32. package/.agents/skills/qa/SKILL.md +130 -0
  33. package/.agents/skills/request-refactor-plan/SKILL.md +68 -0
  34. package/.agents/skills/research/SKILL.md +12 -0
  35. package/.agents/skills/resolving-merge-conflicts/SKILL.md +14 -0
  36. package/.agents/skills/scaffold-exercises/SKILL.md +106 -0
  37. package/.agents/skills/setup-matt-pocock-skills/SKILL.md +116 -0
  38. package/.agents/skills/setup-matt-pocock-skills/domain.md +51 -0
  39. package/.agents/skills/setup-matt-pocock-skills/issue-tracker-github.md +45 -0
  40. package/.agents/skills/setup-matt-pocock-skills/issue-tracker-gitlab.md +46 -0
  41. package/.agents/skills/setup-matt-pocock-skills/issue-tracker-local.md +30 -0
  42. package/.agents/skills/setup-matt-pocock-skills/triage-labels.md +15 -0
  43. package/.agents/skills/setup-pre-commit/SKILL.md +91 -0
  44. package/.agents/skills/setup-ts-deep-modules/SKILL.md +102 -0
  45. package/.agents/skills/setup-ts-deep-modules/dependency-cruiser.config.cjs +95 -0
  46. package/.agents/skills/tdd/SKILL.md +36 -0
  47. package/.agents/skills/tdd/mocking.md +59 -0
  48. package/.agents/skills/tdd/tests.md +77 -0
  49. package/.agents/skills/teach/GLOSSARY-FORMAT.md +35 -0
  50. package/.agents/skills/teach/LEARNING-RECORD-FORMAT.md +46 -0
  51. package/.agents/skills/teach/MISSION-FORMAT.md +31 -0
  52. package/.agents/skills/teach/RESOURCES-FORMAT.md +32 -0
  53. package/.agents/skills/teach/SKILL.md +140 -0
  54. package/.agents/skills/to-spec/SKILL.md +75 -0
  55. package/.agents/skills/to-tickets/SKILL.md +107 -0
  56. package/.agents/skills/triage/AGENT-BRIEF.md +207 -0
  57. package/.agents/skills/triage/OUT-OF-SCOPE.md +105 -0
  58. package/.agents/skills/triage/SKILL.md +112 -0
  59. package/.agents/skills/ubiquitous-language/SKILL.md +93 -0
  60. package/.agents/skills/wayfinder/SKILL.md +127 -0
  61. package/.agents/skills/wizard/SKILL.md +45 -0
  62. package/.agents/skills/wizard/template.sh +211 -0
  63. package/.agents/skills/writing-beats/SKILL.md +67 -0
  64. package/.agents/skills/writing-fragments/SKILL.md +79 -0
  65. package/.agents/skills/writing-great-skills/GLOSSARY.md +201 -0
  66. package/.agents/skills/writing-great-skills/SKILL.md +83 -0
  67. package/.agents/skills/writing-shape/SKILL.md +79 -0
  68. package/.agents/skills-lock.json +233 -0
  69. package/.agents/workflows/kickoff.md +211 -0
  70. package/README.md +63 -0
  71. package/bin/cli.js +24 -0
  72. package/package.json +28 -0
@@ -0,0 +1,140 @@
1
+ ---
2
+ name: teach
3
+ description: Teach the user a new skill or concept, within this workspace.
4
+ disable-model-invocation: true
5
+ argument-hint: "What would you like to learn about?"
6
+ ---
7
+
8
+ The user has asked you to teach them something. This is a stateful request - they intend to learn the topic over multiple sessions.
9
+
10
+ ## Teaching Workspace
11
+
12
+ Treat the current directory as a teaching workspace. The state of their learning is captured in this directory in several files:
13
+
14
+ - `MISSION.md`: A document capturing the _reason_ the user is interested in the topic. This should be used to ground all teaching. Use the format in [MISSION-FORMAT.md](./MISSION-FORMAT.md).
15
+ - `./reference/*.html`: A directory of reference materials. These are the compressed learnings from the lessons - cheat sheets, reference algorithms, syntax, yoga poses, glossaries. They are the raw units of learning. They should be beautiful documents which print out well, and are designed for quick reference.
16
+ - `RESOURCES.md`: A list of resources which can be explored to ground your teaching in contextual knowledge, or to acquire knowledge and wisdom. Use the format in [RESOURCES-FORMAT.md](./RESOURCES-FORMAT.md).
17
+ - `./learning-records/*.md`: A directory of learning records, which capture what the user has learned. These are loosely equivalent to architectural decision records in software development - they capture non-obvious lessons and key insights that may need to be revised later, or drive future sessions. These should be used to calculate the zone of proximal development. They are titled `0001-<dash-case-name>.md`, where the number increments each time. Use the format in [LEARNING-RECORD-FORMAT.md](./LEARNING-RECORD-FORMAT.md).
18
+ - `./lessons/*.html`: A directory of lessons. A **lesson** is a single, self-contained HTML output that teaches one tightly-scoped thing tied to the mission. This is the primary unit of teaching in this workspace.
19
+ - `./assets/*`: Reusable **components** shared across lessons. See [Assets](#assets).
20
+ - `NOTES.md`: A scratchpad for you to jot down user preferences, or working notes.
21
+
22
+ ## Philosophy
23
+
24
+ To learn at a deep level, the user needs three things:
25
+
26
+ - **Knowledge**, captured from high-quality, high-trust resources
27
+ - **Skills**, acquired through highly-relevant interactive lessons devised by you, based on the knowledge
28
+ - **Wisdom**, which comes from interacting with other learners and practitioners
29
+
30
+ Before the `RESOURCES.md` is well-populated, your focus should be to find high-quality resources which will help the user acquire knowledge. Never trust your parametric knowledge.
31
+
32
+ Some topics may require more skills than knowledge. Learning more about theoretical physics might be more knowledge-based. For yoga, more skills-based.
33
+
34
+ ### Fluency vs Storage Strength
35
+
36
+ You should be careful to split between two types of learning:
37
+
38
+ - **Fluency strength**: in-the-moment retrieval of knowledge
39
+ - **Storage strength**: long-term retention of knowledge
40
+
41
+ Fluency can give the user an illusory sense of mastery, but storage strength is the real goal. Try to design lessons which build long-term retention by desirable difficulty:
42
+
43
+ - Using retrieval practice (recall from memory)
44
+ - Spacing (distributing practice over time)
45
+ - Interleaving (mixing up different but related topics in practice - for skills practice only)
46
+
47
+ ## Lessons
48
+
49
+ A lesson is the main thing you produce — the unit in which knowledge and skills reach the user. Each lesson is one self-contained HTML file, saved to `./lessons/` and titled `0001-<dash-case-name>.html` where the number increments each time.
50
+
51
+ A lesson should be **beautiful** — clean, readable typography and layout — since the user will return to these later to review. Think Tufte.
52
+
53
+ The lesson should be short, and completable very quickly. Learners' working memory is very small, and we need to stay within it. But each lesson should give the user a single tangible win that they can build on. It should be directly tied to the mission, and should be in the user's zone of proximal development.
54
+
55
+ If possible, open the lesson file for the user by running a CLI command.
56
+
57
+ Each lesson should link via HTML anchors to other lessons and reference documents.
58
+
59
+ Each lesson should recommend a primary source for the user to read or watch. This should be the most high-quality, high-trust resource you found on the topic.
60
+
61
+ Each lesson should contain a reminder to ask followup questions to the agent. The agent is their teacher, and can assist with anything that's unclear.
62
+
63
+ ## Assets
64
+
65
+ Lessons are built from reusable **components**, stored in `./assets/`: stylesheets, quiz widgets, simulators, diagram helpers — anything a second lesson could reuse.
66
+
67
+ Reuse is the default, not the exception. Before authoring a lesson, read `./assets/` and build from the components already there. When a lesson needs something new and reusable, write it as a component in `./assets/` and link to it — never inline code a future lesson would duplicate.
68
+
69
+ A shared stylesheet is the first component every workspace earns: every lesson links it, so the lessons look like one consistent course rather than a pile of one-offs. As the workspace grows, so should the component library.
70
+
71
+ ## The Mission
72
+
73
+ Every lesson should be tied into the mission - the reason that the user is interested in learning about the topic.
74
+
75
+ If the user is unclear about the mission, or the `MISSION.md` is not populated, your first job should be to question the user on why they want to learn this.
76
+
77
+ Failing to understand the mission will mean knowledge acquisition is not grounded in real-world goals. Lessons will feel too abstract. You will have no way of judging what the user should do next.
78
+
79
+ Missions may change as the user develops more skills and knowledge. This is normal - make sure to update the `MISSION.md` and add a learning record to capture the change. Confirm with the user before changing the mission.
80
+
81
+ ## Zone Of Proximal Development
82
+
83
+ Each lesson, the user should always feel as if they are being challenged 'just enough'.
84
+
85
+ The user may specify an exact thing they want to learn. If they don't, figure out their zone of proximal development by:
86
+
87
+ - Reading their `learning-records`
88
+ - Figuring out the right thing to teach them based on their mission
89
+ - Teach the most relevant thing that fits in their zone of proximal development
90
+
91
+ ## Knowledge
92
+
93
+ Lessons should be designed around a skill the user is going to learn. The knowledge in the lesson should be only what's required to acquire that skill. You teach the knowledge first, then get the user to practice the skills via an interactive feedback loop.
94
+
95
+ Knowledge should first be gathered from trusted resources. Use `RESOURCES.md` to keep track of them. Lessons should be littered with citations - links to external resources to back up any claim made. This increases the trustworthiness of the lesson.
96
+
97
+ For acquiring knowledge, difficulty is the enemy. It eats working memory you need for understanding.
98
+
99
+ ## Skills
100
+
101
+ If knowledge is all about acquisition, skills are about durability and flexibility. Make the knowledge stick.
102
+
103
+ For skill acquisition, difficulty is the tool. Effortful retrieval is what builds storage strength. Skills should be taught through interactive lessons. There are several tools at your disposal:
104
+
105
+ - Interactive lessons, using quizzes and light in-browser tasks
106
+ - Lessons which guide the user through a list of real-world steps to take (for instance, yoga poses)
107
+
108
+ Each of these should be based on a **feedback loop**, where the user receives feedback on their performance. This feedback loop should be as tight as possible, giving feedback immediately - and ideally automatically.
109
+
110
+ For quizzes, each answer should be exactly the same number of words (and characters, if possible). Don't give the user any clues about the answer through formatting.
111
+
112
+ ## Acquiring Wisdom
113
+
114
+ Wisdom comes from true real-world interaction - testing your skills outside the learning environment.
115
+
116
+ When the user asks a question that appears to require wisdom, your default posture should be to attempt to answer - but to ultimately delegate to a **community**.
117
+
118
+ A community is a place (online or offline) where the user can test their skills in the real world. This might be a forum, a subreddit, a real-world class (budget permitting) or a local interest group.
119
+
120
+ You should attempt to find high-reputation communities the user can join. If the user expresses a preference that they don't want to join a community, respect it.
121
+
122
+ ## Reference Documents
123
+
124
+ While creating lessons, you should also create reference documents. Lessons can reference these documents - they are useful for tracking raw units of knowledge useful across lessons.
125
+
126
+ Lessons will rarely be revisited later - reference documents will be. They should be the compressed essence of the lesson, in a format designed for quick reference.
127
+
128
+ Some learning topics lend themselves to reference:
129
+
130
+ - Syntax and code snippets for programming
131
+ - Algorithms and flowcharts for processes
132
+ - Yoga poses and sequences for yoga
133
+ - Exercises and routines for fitness
134
+ - Glossaries for any topic with its own nomenclature
135
+
136
+ Glossaries, in particular, are an essential reference. Once one is created, it should be adhered to in every lesson.
137
+
138
+ ## `NOTES.md`
139
+
140
+ The user will sometimes express preferences of how they want to be taught, or things you should keep in mind. This is the place to record those preferences, so you can refer back to them when designing lessons or working with the user.
@@ -0,0 +1,75 @@
1
+ ---
2
+ name: to-spec
3
+ description: Turn the current conversation into a spec and publish it to the project issue tracker — no interview, just synthesis of what you've already discussed.
4
+ disable-model-invocation: true
5
+ ---
6
+
7
+ This skill takes the current conversation context and codebase understanding and produces a spec (you may know this document as a PRD). Do NOT interview the user — just synthesize what you already know.
8
+
9
+ The issue tracker and triage label vocabulary should have been provided to you — run `/setup-matt-pocock-skills` if not.
10
+
11
+ ## Process
12
+
13
+ 1. Explore the repo to understand the current state of the codebase, if you haven't already. Use the project's domain glossary vocabulary throughout the spec, and respect any ADRs in the area you're touching.
14
+
15
+ 2. Sketch out the seams at which you're going to test the feature. Existing seams should be preferred to new ones. Use the highest seam possible. If new seams are needed, propose them at the highest point you can. The fewer seams across the codebase, the better - the ideal number is one.
16
+
17
+ Check with the user that these seams match their expectations.
18
+
19
+ 3. Write the spec using the template below, then publish it to the project issue tracker. Apply the `ready-for-agent` triage label - no need for additional triage.
20
+
21
+ <spec-template>
22
+
23
+ ## Problem Statement
24
+
25
+ The problem that the user is facing, from the user's perspective.
26
+
27
+ ## Solution
28
+
29
+ The solution to the problem, from the user's perspective.
30
+
31
+ ## User Stories
32
+
33
+ A LONG, numbered list of user stories. Each user story should be in the format of:
34
+
35
+ 1. As an <actor>, I want a <feature>, so that <benefit>
36
+
37
+ <user-story-example>
38
+ 1. As a mobile bank customer, I want to see balance on my accounts, so that I can make better informed decisions about my spending
39
+ </user-story-example>
40
+
41
+ This list of user stories should be extremely extensive and cover all aspects of the feature.
42
+
43
+ ## Implementation Decisions
44
+
45
+ A list of implementation decisions that were made. This can include:
46
+
47
+ - The modules that will be built/modified
48
+ - The interfaces of those modules that will be modified
49
+ - Technical clarifications from the developer
50
+ - Architectural decisions
51
+ - Schema changes
52
+ - API contracts
53
+ - Specific interactions
54
+
55
+ Do NOT include specific file paths or code snippets. They may end up being outdated very quickly.
56
+
57
+ Exception: if a prototype produced a snippet that encodes a decision more precisely than prose can (state machine, reducer, schema, type shape), inline it within the relevant decision and note briefly that it came from a prototype. Trim to the decision-rich parts — not a working demo, just the important bits.
58
+
59
+ ## Testing Decisions
60
+
61
+ A list of testing decisions that were made. Include:
62
+
63
+ - A description of what makes a good test (only test external behavior, not implementation details)
64
+ - Which modules will be tested
65
+ - Prior art for the tests (i.e. similar types of tests in the codebase)
66
+
67
+ ## Out of Scope
68
+
69
+ A description of the things that are out of scope for this spec.
70
+
71
+ ## Further Notes
72
+
73
+ Any further notes about the feature.
74
+
75
+ </spec-template>
@@ -0,0 +1,107 @@
1
+ ---
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 — edges as text in one file per ticket locally, or native blocking links on a real tracker.
4
+ disable-model-invocation: true
5
+ ---
6
+
7
+ # To Tickets
8
+
9
+ Break a plan, spec, or conversation into a set of **tickets** — tracer-bullet vertical slices, each declaring the tickets that **block** it.
10
+
11
+ The issue tracker and triage label vocabulary should have been provided to you — run `/setup-matt-pocock-skills` if not.
12
+
13
+ ## Process
14
+
15
+ ### 1. Gather context
16
+
17
+ Work from whatever is already in the conversation context. If the user passes a reference (a spec path, an issue number or URL) as an argument, fetch it and read its full body and comments.
18
+
19
+ ### 2. Explore the codebase (optional)
20
+
21
+ If you have not already explored the codebase, do so to understand the current state of the code. Ticket titles and descriptions should use the project's domain glossary vocabulary, and respect ADRs in the area you're touching.
22
+
23
+ Look for opportunities to prefactor the code to make the implementation easier. "Make the change easy, then make the easy change."
24
+
25
+ ### 3. Draft vertical slices
26
+
27
+ Break the work into **tracer bullet** tickets.
28
+
29
+ <vertical-slice-rules>
30
+
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
+ - A completed slice is demoable or verifiable on its own
33
+ - Each slice is sized to fit in a single fresh context window
34
+ - Any prefactoring should be done first
35
+
36
+ </vertical-slice-rules>
37
+
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
+
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
+
42
+ ### 4. Quiz the user
43
+
44
+ Present the proposed breakdown as a numbered list. For each ticket, show:
45
+
46
+ - **Title**: short descriptive name
47
+ - **Blocked by**: which other tickets (if any) must complete first
48
+ - **What it delivers**: the end-to-end behaviour this ticket makes work
49
+
50
+ Ask the user:
51
+
52
+ - Does the granularity feel right? (too coarse / too fine)
53
+ - Are the blocking edges correct — does each ticket only depend on tickets that genuinely gate it?
54
+ - Should any tickets be merged or split further?
55
+
56
+ Iterate until the user approves the breakdown.
57
+
58
+ ### 5. Publish the tickets to the configured tracker
59
+
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
+
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
+
65
+ Work the **frontier**: any ticket whose blockers are all done. For a purely linear chain that means top to bottom.
66
+
67
+ Do NOT close or modify any parent issue.
68
+
69
+ <local-ticket-template>
70
+
71
+ # <NN> — <Ticket title>
72
+
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
+
75
+ **Blocked by:** the numbers/titles of the tickets that gate this one, or "None — can start immediately".
76
+
77
+ **Status:** ready-for-agent
78
+
79
+ - [ ] Acceptance criterion 1
80
+ - [ ] Acceptance criterion 2
81
+
82
+ </local-ticket-template>
83
+
84
+ <issue-template>
85
+
86
+ ## Parent
87
+
88
+ A reference to the parent issue on the tracker (if the source was an existing issue, otherwise omit this section).
89
+
90
+ ## What to build
91
+
92
+ The end-to-end behaviour this ticket makes work, from the user's perspective — not layer-by-layer implementation.
93
+
94
+ ## Acceptance criteria
95
+
96
+ - [ ] Criterion 1
97
+ - [ ] Criterion 2
98
+
99
+ ## Blocked by
100
+
101
+ - A reference to each blocking ticket, or "None — can start immediately".
102
+
103
+ </issue-template>
104
+
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.
106
+
107
+ Work the frontier one ticket at a time with `/implement`, clearing context between tickets.
@@ -0,0 +1,207 @@
1
+ # Writing Agent Briefs
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 — the agent brief is the contract.
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* — finish it, close gaps, address review points. Same principles either way; the PR example below shows the difference.
6
+
7
+ ## Principles
8
+
9
+ ### Durability over precision
10
+
11
+ The issue may sit in `ready-for-agent` for days or weeks. The codebase will change in the meantime. Write the brief so it stays useful even as files are renamed, moved, or refactored.
12
+
13
+ - **Do** describe interfaces, types, and behavioral contracts
14
+ - **Do** name specific types, function signatures, or config shapes that the agent should look for or modify
15
+ - **Don't** reference file paths — they go stale
16
+ - **Don't** reference line numbers
17
+ - **Don't** assume the current implementation structure will remain the same
18
+
19
+ ### Behavioral, not procedural
20
+
21
+ Describe **what** the system should do, not **how** to implement it. The agent will explore the codebase fresh and make its own implementation decisions.
22
+
23
+ - **Good:** "The `SkillConfig` type should accept an optional `schedule` field of type `CronExpression`"
24
+ - **Bad:** "Open src/types/skill.ts and add a schedule field on line 42"
25
+ - **Good:** "When a user runs `/triage` with no arguments, they should see a summary of issues needing attention"
26
+ - **Bad:** "Add a switch statement in the main handler function"
27
+
28
+ ### Complete acceptance criteria
29
+
30
+ The agent needs to know when it's done. Every agent brief must have concrete, testable acceptance criteria. Each criterion should be independently verifiable.
31
+
32
+ - **Good:** "Running `gh issue list --label needs-triage` returns issues that have been through initial classification"
33
+ - **Bad:** "Triage should work correctly"
34
+
35
+ ### Explicit scope boundaries
36
+
37
+ State what is out of scope. This prevents the agent from gold-plating or making assumptions about adjacent features.
38
+
39
+ ## Template
40
+
41
+ ```markdown
42
+ ## Agent Brief
43
+
44
+ **Category:** bug / enhancement
45
+ **Summary:** one-line description of what needs to happen
46
+
47
+ **Current behavior:**
48
+ Describe what happens now. For bugs, this is the broken behavior.
49
+ For enhancements, this is the status quo the feature builds on.
50
+
51
+ **Desired behavior:**
52
+ Describe what should happen after the agent's work is complete.
53
+ Be specific about edge cases and error conditions.
54
+
55
+ **Key interfaces:**
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
+
60
+ **Acceptance criteria:**
61
+ - [ ] Specific, testable criterion 1
62
+ - [ ] Specific, testable criterion 2
63
+ - [ ] Specific, testable criterion 3
64
+
65
+ **Out of scope:**
66
+ - Thing that should NOT be changed or addressed in this issue
67
+ - Adjacent feature that might seem related but is separate
68
+ ```
69
+
70
+ ## Examples
71
+
72
+ ### Good agent brief (bug)
73
+
74
+ ```markdown
75
+ ## Agent Brief
76
+
77
+ **Category:** bug
78
+ **Summary:** Skill description truncation drops mid-word, producing broken output
79
+
80
+ **Current behavior:**
81
+ When a skill description exceeds 1024 characters, it is truncated at exactly
82
+ 1024 characters regardless of word boundaries. This produces descriptions
83
+ that end mid-word (e.g. "Use when the user wants to confi").
84
+
85
+ **Desired behavior:**
86
+ Truncation should break at the last word boundary before 1024 characters
87
+ and append "..." to indicate truncation.
88
+
89
+ **Key interfaces:**
90
+ - The `SkillMetadata` type's `description` field — no type change needed,
91
+ but the validation/processing logic that populates it needs to respect
92
+ word boundaries
93
+ - Any function that reads SKILL.md frontmatter and extracts the description
94
+
95
+ **Acceptance criteria:**
96
+ - [ ] Descriptions under 1024 chars are unchanged
97
+ - [ ] Descriptions over 1024 chars are truncated at the last word boundary
98
+ before 1024 chars
99
+ - [ ] Truncated descriptions end with "..."
100
+ - [ ] The total length including "..." does not exceed 1024 chars
101
+
102
+ **Out of scope:**
103
+ - Changing the 1024 char limit itself
104
+ - Multi-line description support
105
+ ```
106
+
107
+ ### Good agent brief (enhancement)
108
+
109
+ ```markdown
110
+ ## Agent Brief
111
+
112
+ **Category:** enhancement
113
+ **Summary:** Add `.out-of-scope/` directory support for tracking rejected feature requests
114
+
115
+ **Current behavior:**
116
+ When a feature request is rejected, the issue is closed with a `wontfix` label
117
+ and a comment. There is no persistent record of the decision or reasoning.
118
+ Future similar requests require the maintainer to recall or search for the
119
+ prior discussion.
120
+
121
+ **Desired behavior:**
122
+ Rejected feature requests should be documented in `.out-of-scope/<concept>.md`
123
+ files that capture the decision, reasoning, and links to all issues that
124
+ requested the feature. When triaging new issues, these files should be
125
+ checked for matches.
126
+
127
+ **Key interfaces:**
128
+ - Markdown file format in `.out-of-scope/` — each file should have a
129
+ `# Concept Name` heading, a `**Decision:**` line, a `**Reason:**` line,
130
+ and a `**Prior requests:**` list with issue links
131
+ - The triage workflow should read all `.out-of-scope/*.md` files early
132
+ and match incoming issues against them by concept similarity
133
+
134
+ **Acceptance criteria:**
135
+ - [ ] Closing a feature as wontfix creates/updates a file in `.out-of-scope/`
136
+ - [ ] The file includes the decision, reasoning, and link to the closed issue
137
+ - [ ] If a matching `.out-of-scope/` file already exists, the new issue is
138
+ appended to its "Prior requests" list rather than creating a duplicate
139
+ - [ ] During triage, existing `.out-of-scope/` files are checked and surfaced
140
+ when a new issue matches a prior rejection
141
+
142
+ **Out of scope:**
143
+ - Automated matching (human confirms the match)
144
+ - Reopening previously rejected features
145
+ - Bug reports (only enhancement rejections go to `.out-of-scope/`)
146
+ ```
147
+
148
+ ### Good agent brief (PR)
149
+
150
+ For a PR, "Current behavior" describes the state of the diff, and the brief asks the agent to finish or fix it rather than build from scratch.
151
+
152
+ ```markdown
153
+ ## Agent Brief
154
+
155
+ **Category:** enhancement
156
+ **Summary:** Finish the contributor's `--json` output flag for `triage list`
157
+
158
+ **Current behavior:**
159
+ The PR adds a `--json` flag that serializes the issue list to JSON. The happy
160
+ path works and the diff matches the project's command structure. Two gaps
161
+ remain: errors are still printed as human text (not JSON), and the new flag has
162
+ no test coverage.
163
+
164
+ **Desired behavior:**
165
+ With `--json`, all output — including errors — is well-formed JSON on stdout,
166
+ and the command's exit codes are unchanged. The existing human-readable output
167
+ is untouched when the flag is absent.
168
+
169
+ **Key interfaces:**
170
+ - The command's error path should emit `{ "error": string }` under `--json`
171
+ instead of the plain-text error
172
+ - Reuse the existing serializer the PR already added; don't introduce a second
173
+
174
+ **Acceptance criteria:**
175
+ - [ ] `triage list --json` emits valid JSON for both success and error cases
176
+ - [ ] Exit codes match the non-JSON command
177
+ - [ ] A test covers the `--json` success output and one error case
178
+ - [ ] Default (non-JSON) output is byte-for-byte unchanged
179
+
180
+ **Out of scope:**
181
+ - Adding `--json` to any other command
182
+ - Changing the JSON shape of the success payload the PR already defined
183
+ ```
184
+
185
+ ### Bad agent brief
186
+
187
+ ```markdown
188
+ ## Agent Brief
189
+
190
+ **Summary:** Fix the triage bug
191
+
192
+ **What to do:**
193
+ The triage thing is broken. Look at the main file and fix it.
194
+ The function around line 150 has the issue.
195
+
196
+ **Files to change:**
197
+ - src/triage/handler.ts (line 150)
198
+ - src/types.ts (line 42)
199
+ ```
200
+
201
+ This is bad because:
202
+ - No category
203
+ - Vague description ("the triage thing is broken")
204
+ - References file paths and line numbers that will go stale
205
+ - No acceptance criteria
206
+ - No scope boundaries
207
+ - No description of current vs desired behavior
@@ -0,0 +1,105 @@
1
+ # Out-of-Scope Knowledge Base
2
+
3
+ The `.out-of-scope/` directory in a repo stores persistent records of rejected feature requests. It serves two purposes:
4
+
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
+
8
+ ## Directory structure
9
+
10
+ ```
11
+ .out-of-scope/
12
+ ├── dark-mode.md
13
+ ├── plugin-system.md
14
+ └── graphql-api.md
15
+ ```
16
+
17
+ One file per **concept**, not per issue. Multiple issues requesting the same thing are grouped under one file.
18
+
19
+ ## File format
20
+
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
+
23
+ ```markdown
24
+ # Dark Mode
25
+
26
+ This project does not support dark mode or user-facing theming.
27
+
28
+ ## Why this is out of scope
29
+
30
+ The rendering pipeline assumes a single color palette defined in
31
+ `ThemeConfig`. Supporting multiple themes would require:
32
+
33
+ - A theme context provider wrapping the entire component tree
34
+ - Per-component theme-aware style resolution
35
+ - A persistence layer for user theme preferences
36
+
37
+ This is a significant architectural change that doesn't align with the
38
+ project's focus on content authoring. Theming is a concern for downstream
39
+ consumers who embed or redistribute the output.
40
+
41
+ ```ts
42
+ // The current ThemeConfig interface is not designed for runtime switching:
43
+ interface ThemeConfig {
44
+ colors: ColorPalette; // single palette, resolved at build time
45
+ fonts: FontStack;
46
+ }
47
+ ```
48
+
49
+ ## Prior requests
50
+
51
+ - #42 — "Add dark mode support"
52
+ - #87 — "Night theme for accessibility"
53
+ - #134 — "Dark theme option"
54
+ ```
55
+
56
+ ### Naming the file
57
+
58
+ Use a short, descriptive kebab-case name for the concept: `dark-mode.md`, `plugin-system.md`, `graphql-api.md`. The name should be recognizable enough that someone browsing the directory understands what was rejected without opening the file.
59
+
60
+ ### Writing the reason
61
+
62
+ The reason should be substantive — not "we don't want this" but why. Good reasons reference:
63
+
64
+ - Project scope or philosophy ("This project focuses on X; theming is a downstream concern")
65
+ - Technical constraints ("Supporting this would require Y, which conflicts with our Z architecture")
66
+ - Strategic decisions ("We chose to use A instead of B because...")
67
+
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
+
70
+ ## When to check `.out-of-scope/`
71
+
72
+ During triage (Step 1: Gather context), read all files in `.out-of-scope/`. When evaluating a new issue:
73
+
74
+ - Check if the request matches an existing out-of-scope concept
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
+
78
+ The maintainer may:
79
+
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
+
84
+ ## When to write to `.out-of-scope/`
85
+
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
+
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
+
90
+ The flow:
91
+
92
+ 1. Maintainer decides a feature request is out of scope
93
+ 2. Check if a matching `.out-of-scope/` file already exists
94
+ 3. If yes: append the new issue to the "Prior requests" list
95
+ 4. If no: create a new file with the concept name, decision, reason, and first prior request
96
+ 5. Post a comment on the issue explaining the decision and mentioning the `.out-of-scope/` file
97
+ 6. Close the issue with the `wontfix` label
98
+
99
+ ## Updating or removing out-of-scope files
100
+
101
+ If the maintainer changes their mind about a previously rejected concept:
102
+
103
+ - Delete the `.out-of-scope/` file
104
+ - The skill does not need to reopen old issues — they're historical records
105
+ - The new issue that triggered the reconsideration proceeds through normal triage