self-evolve-framework 1.0.8 → 1.1.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.
- package/bin/cli.js +66 -24
- package/package.json +1 -1
- package/template/rules/CodeGraph.mdc +23 -0
- package/template/rules/Svelte_5.mdc +167 -0
- package/template/rules/Svelte_Flow.mdc +176 -0
- package/template/rules/Tailwind_CSS_v4.mdc +187 -0
- package/template/rules/Tauri.mdc +145 -0
- package/template/rules/app-error-pattern.mdc +65 -0
- package/template/rules/invoke-safe-pattern.mdc +53 -0
- package/template/rules/js.mdc +10 -0
- package/template/rules/powershell.mdc +9 -0
- package/template/rules//346/227/245/345/277/227.mdc +15 -0
- package/template/rules//350/257/267/346/261/202.mdc +49 -0
- package/template/skills/caveman/SKILL.md +49 -0
- package/template/skills/check/SKILL.md +393 -0
- package/template/skills/check/agents/reviewer-architecture.md +39 -0
- package/template/skills/check/agents/reviewer-security.md +39 -0
- package/template/skills/check/references/persona-catalog.md +56 -0
- package/template/skills/check/references/project-context.md +120 -0
- package/template/skills/check/references/public-reply.md +14 -0
- package/template/skills/check/scripts/audit_signals.py +666 -0
- package/template/skills/check/scripts/run-tests.sh +19 -0
- package/template/skills/design/SKILL.md +173 -0
- package/template/skills/design/references/design-aesthetic-quality.md +67 -0
- package/template/skills/design/references/design-data-viz.md +34 -0
- package/template/skills/design/references/design-reference.md +295 -0
- package/template/skills/design/references/design-tokens.md +45 -0
- package/template/skills/design/references/design-traps.md +43 -0
- package/template/skills/design-an-interface/SKILL.md +94 -0
- package/template/skills/diagnose/SKILL.md +117 -0
- package/template/skills/diagnose/scripts/hitl-loop.template.sh +41 -0
- package/template/skills/edit-article/SKILL.md +14 -0
- package/template/skills/git-guardrails-claude-code/SKILL.md +95 -0
- package/template/skills/git-guardrails-claude-code/scripts/block-dangerous-git.sh +25 -0
- package/template/skills/grill-me/SKILL.md +10 -0
- package/template/skills/grill-with-docs/ADR-FORMAT.md +47 -0
- package/template/skills/grill-with-docs/CONTEXT-FORMAT.md +60 -0
- package/template/skills/grill-with-docs/SKILL.md +88 -0
- package/template/skills/handoff/SKILL.md +15 -0
- package/template/skills/health/SKILL.md +260 -0
- package/template/skills/health/agents/inspector-context.md +119 -0
- package/template/skills/health/agents/inspector-control.md +84 -0
- package/template/skills/health/agents/inspector-maintainability.md +55 -0
- package/template/skills/health/scripts/check-agent-context.sh +5 -0
- package/template/skills/health/scripts/check-doc-refs.sh +8 -0
- package/template/skills/health/scripts/check-maintainability.sh +8 -0
- package/template/skills/health/scripts/check-verifier-output.sh +5 -0
- package/template/skills/health/scripts/check_agent_context.py +444 -0
- package/template/skills/health/scripts/check_doc_refs.py +110 -0
- package/template/skills/health/scripts/check_maintainability.py +635 -0
- package/template/skills/health/scripts/check_verifier_output.py +116 -0
- package/template/skills/health/scripts/collect-data.sh +751 -0
- package/template/skills/hunt/SKILL.md +232 -0
- package/template/skills/hunt/references/failure-patterns.md +138 -0
- package/template/skills/hunt/references/ime-unicode.md +58 -0
- package/template/skills/hunt/references/logging-techniques.md +72 -0
- package/template/skills/hunt/references/rendering-debug.md +34 -0
- package/template/skills/improve-codebase-architecture/DEEPENING.md +37 -0
- package/template/skills/improve-codebase-architecture/HTML-REPORT.md +123 -0
- package/template/skills/improve-codebase-architecture/INTERFACE-DESIGN.md +44 -0
- package/template/skills/improve-codebase-architecture/LANGUAGE.md +53 -0
- package/template/skills/improve-codebase-architecture/SKILL.md +81 -0
- package/template/skills/learn/SKILL.md +140 -0
- package/template/skills/migrate-to-shoehorn/SKILL.md +118 -0
- package/template/skills/obsidian-vault/SKILL.md +59 -0
- package/template/skills/prototype/LOGIC.md +79 -0
- package/template/skills/prototype/SKILL.md +30 -0
- package/template/skills/prototype/UI.md +112 -0
- package/template/skills/qa/SKILL.md +130 -0
- package/template/skills/read/SKILL.md +141 -0
- package/template/skills/read/references/read-methods.md +129 -0
- package/template/skills/read/scripts/fetch.sh +106 -0
- package/template/skills/read/scripts/fetch_feishu.py +251 -0
- package/template/skills/read/scripts/fetch_local.py +218 -0
- package/template/skills/read/scripts/fetch_weixin.py +107 -0
- package/template/skills/request-refactor-plan/SKILL.md +68 -0
- package/template/skills/review/SKILL.md +78 -0
- package/template/skills/rust-auto-fix/SKILL.md +94 -0
- package/template/skills/scaffold-exercises/SKILL.md +106 -0
- package/template/skills/sdd-dev/SKILL.md +114 -0
- package/template/skills/setup-matt-pocock-skills/SKILL.md +121 -0
- package/template/skills/setup-matt-pocock-skills/domain.md +51 -0
- package/template/skills/setup-matt-pocock-skills/issue-tracker-github.md +22 -0
- package/template/skills/setup-matt-pocock-skills/issue-tracker-gitlab.md +23 -0
- package/template/skills/setup-matt-pocock-skills/issue-tracker-local.md +19 -0
- package/template/skills/setup-matt-pocock-skills/triage-labels.md +15 -0
- package/template/skills/setup-pre-commit/SKILL.md +91 -0
- package/template/skills/svelte-warnings-fix/SKILL.md +94 -0
- package/template/skills/tauri-nsis-installer-icon/SKILL.md +92 -0
- package/template/skills/tauri-nsis-installer-icon/references/tauri-nsis-schema.md +71 -0
- package/template/skills/tb/SKILL.md +62 -0
- package/template/skills/tdd/SKILL.md +109 -0
- package/template/skills/tdd/deep-modules.md +33 -0
- package/template/skills/tdd/interface-design.md +31 -0
- package/template/skills/tdd/mocking.md +59 -0
- package/template/skills/tdd/refactoring.md +10 -0
- package/template/skills/tdd/tests.md +61 -0
- package/template/skills/teach/GLOSSARY-FORMAT.md +35 -0
- package/template/skills/teach/LEARNING-RECORD-FORMAT.md +46 -0
- package/template/skills/teach/MISSION-FORMAT.md +31 -0
- package/template/skills/teach/RESOURCES-FORMAT.md +32 -0
- package/template/skills/teach/SKILL.md +91 -0
- package/template/skills/think/SKILL.md +184 -0
- package/template/skills/to-issues/SKILL.md +83 -0
- package/template/skills/to-prd/SKILL.md +74 -0
- package/template/skills/triage/AGENT-BRIEF.md +168 -0
- package/template/skills/triage/OUT-OF-SCOPE.md +101 -0
- package/template/skills/triage/SKILL.md +103 -0
- package/template/skills/ubiquitous-language/SKILL.md +93 -0
- package/template/skills/ver/SKILL.md +62 -0
- package/template/skills/write/SKILL.md +209 -0
- package/template/skills/write/references/write-en.md +199 -0
- package/template/skills/write/references/write-product-localization.md +43 -0
- package/template/skills/write/references/write-zh-bilingual.md +59 -0
- package/template/skills/write/references/write-zh-prose.md +50 -0
- package/template/skills/write/references/write-zh-release-notes.md +40 -0
- package/template/skills/write/references/write-zh.md +721 -0
- package/template/skills/write-a-skill/SKILL.md +117 -0
- package/template/skills/writing-beats/SKILL.md +52 -0
- package/template/skills/writing-fragments/SKILL.md +75 -0
- package/template/skills/writing-shape/SKILL.md +64 -0
- package/template/skills/zoom-out/SKILL.md +7 -0
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: to-prd
|
|
3
|
+
description: Turn the current conversation context into a PRD and publish it to the project issue tracker. Use when user wants to create a PRD from the current context.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
This skill takes the current conversation context and codebase understanding and produces a PRD. Do NOT interview the user — just synthesize what you already know.
|
|
7
|
+
|
|
8
|
+
The issue tracker and triage label vocabulary should have been provided to you — run `/setup-matt-pocock-skills` if not.
|
|
9
|
+
|
|
10
|
+
## Process
|
|
11
|
+
|
|
12
|
+
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 PRD, and respect any ADRs in the area you're touching.
|
|
13
|
+
|
|
14
|
+
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.
|
|
15
|
+
|
|
16
|
+
Check with the user that these seams match their expectations.
|
|
17
|
+
|
|
18
|
+
3. Write the PRD using the template below, then publish it to the project issue tracker. Apply the `ready-for-agent` triage label - no need for additional triage.
|
|
19
|
+
|
|
20
|
+
<prd-template>
|
|
21
|
+
|
|
22
|
+
## Problem Statement
|
|
23
|
+
|
|
24
|
+
The problem that the user is facing, from the user's perspective.
|
|
25
|
+
|
|
26
|
+
## Solution
|
|
27
|
+
|
|
28
|
+
The solution to the problem, from the user's perspective.
|
|
29
|
+
|
|
30
|
+
## User Stories
|
|
31
|
+
|
|
32
|
+
A LONG, numbered list of user stories. Each user story should be in the format of:
|
|
33
|
+
|
|
34
|
+
1. As an <actor>, I want a <feature>, so that <benefit>
|
|
35
|
+
|
|
36
|
+
<user-story-example>
|
|
37
|
+
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
|
|
38
|
+
</user-story-example>
|
|
39
|
+
|
|
40
|
+
This list of user stories should be extremely extensive and cover all aspects of the feature.
|
|
41
|
+
|
|
42
|
+
## Implementation Decisions
|
|
43
|
+
|
|
44
|
+
A list of implementation decisions that were made. This can include:
|
|
45
|
+
|
|
46
|
+
- The modules that will be built/modified
|
|
47
|
+
- The interfaces of those modules that will be modified
|
|
48
|
+
- Technical clarifications from the developer
|
|
49
|
+
- Architectural decisions
|
|
50
|
+
- Schema changes
|
|
51
|
+
- API contracts
|
|
52
|
+
- Specific interactions
|
|
53
|
+
|
|
54
|
+
Do NOT include specific file paths or code snippets. They may end up being outdated very quickly.
|
|
55
|
+
|
|
56
|
+
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.
|
|
57
|
+
|
|
58
|
+
## Testing Decisions
|
|
59
|
+
|
|
60
|
+
A list of testing decisions that were made. Include:
|
|
61
|
+
|
|
62
|
+
- A description of what makes a good test (only test external behavior, not implementation details)
|
|
63
|
+
- Which modules will be tested
|
|
64
|
+
- Prior art for the tests (i.e. similar types of tests in the codebase)
|
|
65
|
+
|
|
66
|
+
## Out of Scope
|
|
67
|
+
|
|
68
|
+
A description of the things that are out of scope for this PRD.
|
|
69
|
+
|
|
70
|
+
## Further Notes
|
|
71
|
+
|
|
72
|
+
Any further notes about the feature.
|
|
73
|
+
|
|
74
|
+
</prd-template>
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
# Writing Agent Briefs
|
|
2
|
+
|
|
3
|
+
An agent brief is a structured comment posted on a GitHub issue when it moves to `ready-for-agent`. It is the authoritative specification that an AFK agent will work from. The original issue body and discussion are context — the agent brief is the contract.
|
|
4
|
+
|
|
5
|
+
## Principles
|
|
6
|
+
|
|
7
|
+
### Durability over precision
|
|
8
|
+
|
|
9
|
+
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.
|
|
10
|
+
|
|
11
|
+
- **Do** describe interfaces, types, and behavioral contracts
|
|
12
|
+
- **Do** name specific types, function signatures, or config shapes that the agent should look for or modify
|
|
13
|
+
- **Don't** reference file paths — they go stale
|
|
14
|
+
- **Don't** reference line numbers
|
|
15
|
+
- **Don't** assume the current implementation structure will remain the same
|
|
16
|
+
|
|
17
|
+
### Behavioral, not procedural
|
|
18
|
+
|
|
19
|
+
Describe **what** the system should do, not **how** to implement it. The agent will explore the codebase fresh and make its own implementation decisions.
|
|
20
|
+
|
|
21
|
+
- **Good:** "The `SkillConfig` type should accept an optional `schedule` field of type `CronExpression`"
|
|
22
|
+
- **Bad:** "Open src/types/skill.ts and add a schedule field on line 42"
|
|
23
|
+
- **Good:** "When a user runs `/triage` with no arguments, they should see a summary of issues needing attention"
|
|
24
|
+
- **Bad:** "Add a switch statement in the main handler function"
|
|
25
|
+
|
|
26
|
+
### Complete acceptance criteria
|
|
27
|
+
|
|
28
|
+
The agent needs to know when it's done. Every agent brief must have concrete, testable acceptance criteria. Each criterion should be independently verifiable.
|
|
29
|
+
|
|
30
|
+
- **Good:** "Running `gh issue list --label needs-triage` returns issues that have been through initial classification"
|
|
31
|
+
- **Bad:** "Triage should work correctly"
|
|
32
|
+
|
|
33
|
+
### Explicit scope boundaries
|
|
34
|
+
|
|
35
|
+
State what is out of scope. This prevents the agent from gold-plating or making assumptions about adjacent features.
|
|
36
|
+
|
|
37
|
+
## Template
|
|
38
|
+
|
|
39
|
+
```markdown
|
|
40
|
+
## Agent Brief
|
|
41
|
+
|
|
42
|
+
**Category:** bug / enhancement
|
|
43
|
+
**Summary:** one-line description of what needs to happen
|
|
44
|
+
|
|
45
|
+
**Current behavior:**
|
|
46
|
+
Describe what happens now. For bugs, this is the broken behavior.
|
|
47
|
+
For enhancements, this is the status quo the feature builds on.
|
|
48
|
+
|
|
49
|
+
**Desired behavior:**
|
|
50
|
+
Describe what should happen after the agent's work is complete.
|
|
51
|
+
Be specific about edge cases and error conditions.
|
|
52
|
+
|
|
53
|
+
**Key interfaces:**
|
|
54
|
+
- `TypeName` — what needs to change and why
|
|
55
|
+
- `functionName()` return type — what it currently returns vs what it should return
|
|
56
|
+
- Config shape — any new configuration options needed
|
|
57
|
+
|
|
58
|
+
**Acceptance criteria:**
|
|
59
|
+
- [ ] Specific, testable criterion 1
|
|
60
|
+
- [ ] Specific, testable criterion 2
|
|
61
|
+
- [ ] Specific, testable criterion 3
|
|
62
|
+
|
|
63
|
+
**Out of scope:**
|
|
64
|
+
- Thing that should NOT be changed or addressed in this issue
|
|
65
|
+
- Adjacent feature that might seem related but is separate
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Examples
|
|
69
|
+
|
|
70
|
+
### Good agent brief (bug)
|
|
71
|
+
|
|
72
|
+
```markdown
|
|
73
|
+
## Agent Brief
|
|
74
|
+
|
|
75
|
+
**Category:** bug
|
|
76
|
+
**Summary:** Skill description truncation drops mid-word, producing broken output
|
|
77
|
+
|
|
78
|
+
**Current behavior:**
|
|
79
|
+
When a skill description exceeds 1024 characters, it is truncated at exactly
|
|
80
|
+
1024 characters regardless of word boundaries. This produces descriptions
|
|
81
|
+
that end mid-word (e.g. "Use when the user wants to confi").
|
|
82
|
+
|
|
83
|
+
**Desired behavior:**
|
|
84
|
+
Truncation should break at the last word boundary before 1024 characters
|
|
85
|
+
and append "..." to indicate truncation.
|
|
86
|
+
|
|
87
|
+
**Key interfaces:**
|
|
88
|
+
- The `SkillMetadata` type's `description` field — no type change needed,
|
|
89
|
+
but the validation/processing logic that populates it needs to respect
|
|
90
|
+
word boundaries
|
|
91
|
+
- Any function that reads SKILL.md frontmatter and extracts the description
|
|
92
|
+
|
|
93
|
+
**Acceptance criteria:**
|
|
94
|
+
- [ ] Descriptions under 1024 chars are unchanged
|
|
95
|
+
- [ ] Descriptions over 1024 chars are truncated at the last word boundary
|
|
96
|
+
before 1024 chars
|
|
97
|
+
- [ ] Truncated descriptions end with "..."
|
|
98
|
+
- [ ] The total length including "..." does not exceed 1024 chars
|
|
99
|
+
|
|
100
|
+
**Out of scope:**
|
|
101
|
+
- Changing the 1024 char limit itself
|
|
102
|
+
- Multi-line description support
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Good agent brief (enhancement)
|
|
106
|
+
|
|
107
|
+
```markdown
|
|
108
|
+
## Agent Brief
|
|
109
|
+
|
|
110
|
+
**Category:** enhancement
|
|
111
|
+
**Summary:** Add `.out-of-scope/` directory support for tracking rejected feature requests
|
|
112
|
+
|
|
113
|
+
**Current behavior:**
|
|
114
|
+
When a feature request is rejected, the issue is closed with a `wontfix` label
|
|
115
|
+
and a comment. There is no persistent record of the decision or reasoning.
|
|
116
|
+
Future similar requests require the maintainer to recall or search for the
|
|
117
|
+
prior discussion.
|
|
118
|
+
|
|
119
|
+
**Desired behavior:**
|
|
120
|
+
Rejected feature requests should be documented in `.out-of-scope/<concept>.md`
|
|
121
|
+
files that capture the decision, reasoning, and links to all issues that
|
|
122
|
+
requested the feature. When triaging new issues, these files should be
|
|
123
|
+
checked for matches.
|
|
124
|
+
|
|
125
|
+
**Key interfaces:**
|
|
126
|
+
- Markdown file format in `.out-of-scope/` — each file should have a
|
|
127
|
+
`# Concept Name` heading, a `**Decision:**` line, a `**Reason:**` line,
|
|
128
|
+
and a `**Prior requests:**` list with issue links
|
|
129
|
+
- The triage workflow should read all `.out-of-scope/*.md` files early
|
|
130
|
+
and match incoming issues against them by concept similarity
|
|
131
|
+
|
|
132
|
+
**Acceptance criteria:**
|
|
133
|
+
- [ ] Closing a feature as wontfix creates/updates a file in `.out-of-scope/`
|
|
134
|
+
- [ ] The file includes the decision, reasoning, and link to the closed issue
|
|
135
|
+
- [ ] If a matching `.out-of-scope/` file already exists, the new issue is
|
|
136
|
+
appended to its "Prior requests" list rather than creating a duplicate
|
|
137
|
+
- [ ] During triage, existing `.out-of-scope/` files are checked and surfaced
|
|
138
|
+
when a new issue matches a prior rejection
|
|
139
|
+
|
|
140
|
+
**Out of scope:**
|
|
141
|
+
- Automated matching (human confirms the match)
|
|
142
|
+
- Reopening previously rejected features
|
|
143
|
+
- Bug reports (only enhancement rejections go to `.out-of-scope/`)
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Bad agent brief
|
|
147
|
+
|
|
148
|
+
```markdown
|
|
149
|
+
## Agent Brief
|
|
150
|
+
|
|
151
|
+
**Summary:** Fix the triage bug
|
|
152
|
+
|
|
153
|
+
**What to do:**
|
|
154
|
+
The triage thing is broken. Look at the main file and fix it.
|
|
155
|
+
The function around line 150 has the issue.
|
|
156
|
+
|
|
157
|
+
**Files to change:**
|
|
158
|
+
- src/triage/handler.ts (line 150)
|
|
159
|
+
- src/types.ts (line 42)
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
This is bad because:
|
|
163
|
+
- No category
|
|
164
|
+
- Vague description ("the triage thing is broken")
|
|
165
|
+
- References file paths and line numbers that will go stale
|
|
166
|
+
- No acceptance criteria
|
|
167
|
+
- No scope boundaries
|
|
168
|
+
- No description of current vs desired behavior
|
|
@@ -0,0 +1,101 @@
|
|
|
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`. The flow:
|
|
87
|
+
|
|
88
|
+
1. Maintainer decides a feature request is out of scope
|
|
89
|
+
2. Check if a matching `.out-of-scope/` file already exists
|
|
90
|
+
3. If yes: append the new issue to the "Prior requests" list
|
|
91
|
+
4. If no: create a new file with the concept name, decision, reason, and first prior request
|
|
92
|
+
5. Post a comment on the issue explaining the decision and mentioning the `.out-of-scope/` file
|
|
93
|
+
6. Close the issue with the `wontfix` label
|
|
94
|
+
|
|
95
|
+
## Updating or removing out-of-scope files
|
|
96
|
+
|
|
97
|
+
If the maintainer changes their mind about a previously rejected concept:
|
|
98
|
+
|
|
99
|
+
- Delete the `.out-of-scope/` file
|
|
100
|
+
- The skill does not need to reopen old issues — they're historical records
|
|
101
|
+
- The new issue that triggered the reconsideration proceeds through normal triage
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: triage
|
|
3
|
+
description: Triage issues through a state machine driven by triage roles. Use when user wants to create an issue, triage issues, review incoming bugs or feature requests, prepare issues for an AFK agent, or manage issue workflow.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Triage
|
|
7
|
+
|
|
8
|
+
Move issues on the project issue tracker through a small state machine of triage roles.
|
|
9
|
+
|
|
10
|
+
Every comment or issue posted to the issue tracker during triage **must** start with this disclaimer:
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
> *This was generated by AI during triage.*
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Reference docs
|
|
17
|
+
|
|
18
|
+
- [AGENT-BRIEF.md](AGENT-BRIEF.md) — how to write durable agent briefs
|
|
19
|
+
- [OUT-OF-SCOPE.md](OUT-OF-SCOPE.md) — how the `.out-of-scope/` knowledge base works
|
|
20
|
+
|
|
21
|
+
## Roles
|
|
22
|
+
|
|
23
|
+
Two **category** roles:
|
|
24
|
+
|
|
25
|
+
- `bug` — something is broken
|
|
26
|
+
- `enhancement` — new feature or improvement
|
|
27
|
+
|
|
28
|
+
Five **state** roles:
|
|
29
|
+
|
|
30
|
+
- `needs-triage` — maintainer needs to evaluate
|
|
31
|
+
- `needs-info` — waiting on reporter for more information
|
|
32
|
+
- `ready-for-agent` — fully specified, ready for an AFK agent
|
|
33
|
+
- `ready-for-human` — needs human implementation
|
|
34
|
+
- `wontfix` — will not be actioned
|
|
35
|
+
|
|
36
|
+
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.
|
|
37
|
+
|
|
38
|
+
These are canonical role names — the actual label strings used in the issue tracker may differ. The mapping should have been provided to you - run `/setup-matt-pocock-skills` if not.
|
|
39
|
+
|
|
40
|
+
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.
|
|
41
|
+
|
|
42
|
+
## Invocation
|
|
43
|
+
|
|
44
|
+
The maintainer invokes `/triage` and describes what they want in natural language. Interpret the request and act. Examples:
|
|
45
|
+
|
|
46
|
+
- "Show me anything that needs my attention"
|
|
47
|
+
- "Let's look at #42"
|
|
48
|
+
- "Move #42 to ready-for-agent"
|
|
49
|
+
- "What's ready for agents to pick up?"
|
|
50
|
+
|
|
51
|
+
## Show what needs attention
|
|
52
|
+
|
|
53
|
+
Query the issue tracker and present three buckets, oldest first:
|
|
54
|
+
|
|
55
|
+
1. **Unlabeled** — never triaged.
|
|
56
|
+
2. **`needs-triage`** — evaluation in progress.
|
|
57
|
+
3. **`needs-info` with reporter activity since the last triage notes** — needs re-evaluation.
|
|
58
|
+
|
|
59
|
+
Show counts and a one-line summary per issue. Let the maintainer pick.
|
|
60
|
+
|
|
61
|
+
## Triage a specific issue
|
|
62
|
+
|
|
63
|
+
1. **Gather context.** Read the full issue (body, comments, labels, reporter, dates). 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. Read `.out-of-scope/*.md` and surface any prior rejection that resembles this issue.
|
|
64
|
+
|
|
65
|
+
2. **Recommend.** Tell the maintainer your category and state recommendation with reasoning, plus a brief codebase summary relevant to the issue. Wait for direction.
|
|
66
|
+
|
|
67
|
+
3. **Reproduce (bugs only).** Before any grilling, attempt reproduction: read the reporter's steps, trace the relevant code, run tests or commands. Report what happened — successful repro with code path, failed repro, or insufficient detail (a strong `needs-info` signal). A confirmed repro makes a much stronger agent brief.
|
|
68
|
+
|
|
69
|
+
4. **Grill (if needed).** If the issue needs fleshing out, run a `/grill-with-docs` session.
|
|
70
|
+
|
|
71
|
+
5. **Apply the outcome:**
|
|
72
|
+
- `ready-for-agent` — post an agent brief comment ([AGENT-BRIEF.md](AGENT-BRIEF.md)).
|
|
73
|
+
- `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).
|
|
74
|
+
- `needs-info` — post triage notes (template below).
|
|
75
|
+
- `wontfix` (bug) — polite explanation, then close.
|
|
76
|
+
- `wontfix` (enhancement) — write to `.out-of-scope/`, link to it from a comment, then close ([OUT-OF-SCOPE.md](OUT-OF-SCOPE.md)).
|
|
77
|
+
- `needs-triage` — apply the role. Optional comment if there's partial progress.
|
|
78
|
+
|
|
79
|
+
## Quick state override
|
|
80
|
+
|
|
81
|
+
If the maintainer says "move #42 to ready-for-agent", trust them and apply the role directly. Confirm what you're about to do (role changes, comment, close), then act. Skip grilling. If moving to `ready-for-agent` without a grilling session, ask whether they want to write an agent brief.
|
|
82
|
+
|
|
83
|
+
## Needs-info template
|
|
84
|
+
|
|
85
|
+
```markdown
|
|
86
|
+
## Triage Notes
|
|
87
|
+
|
|
88
|
+
**What we've established so far:**
|
|
89
|
+
|
|
90
|
+
- point 1
|
|
91
|
+
- point 2
|
|
92
|
+
|
|
93
|
+
**What we still need from you (@reporter):**
|
|
94
|
+
|
|
95
|
+
- question 1
|
|
96
|
+
- question 2
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Capture everything resolved during grilling under "established so far" so the work isn't lost. Questions must be specific and actionable, not "please provide more info".
|
|
100
|
+
|
|
101
|
+
## Resuming a previous session
|
|
102
|
+
|
|
103
|
+
If prior triage notes exist on the issue, read them, check whether the reporter has answered any outstanding questions, and present an updated picture before continuing. Don't re-ask resolved questions.
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ubiquitous-language
|
|
3
|
+
description: Extract a DDD-style ubiquitous language glossary from the current conversation, flagging ambiguities and proposing canonical terms. Saves to UBIQUITOUS_LANGUAGE.md. Use when user wants to define domain terms, build a glossary, harden terminology, create a ubiquitous language, or mentions "domain model" or "DDD".
|
|
4
|
+
disable-model-invocation: true
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Ubiquitous Language
|
|
8
|
+
|
|
9
|
+
Extract and formalize domain terminology from the current conversation into a consistent glossary, saved to a local file.
|
|
10
|
+
|
|
11
|
+
## Process
|
|
12
|
+
|
|
13
|
+
1. **Scan the conversation** for domain-relevant nouns, verbs, and concepts
|
|
14
|
+
2. **Identify problems**:
|
|
15
|
+
- Same word used for different concepts (ambiguity)
|
|
16
|
+
- Different words used for the same concept (synonyms)
|
|
17
|
+
- Vague or overloaded terms
|
|
18
|
+
3. **Propose a canonical glossary** with opinionated term choices
|
|
19
|
+
4. **Write to `UBIQUITOUS_LANGUAGE.md`** in the working directory using the format below
|
|
20
|
+
5. **Output a summary** inline in the conversation
|
|
21
|
+
|
|
22
|
+
## Output Format
|
|
23
|
+
|
|
24
|
+
Write a `UBIQUITOUS_LANGUAGE.md` file with this structure:
|
|
25
|
+
|
|
26
|
+
```md
|
|
27
|
+
# Ubiquitous Language
|
|
28
|
+
|
|
29
|
+
## Order lifecycle
|
|
30
|
+
|
|
31
|
+
| Term | Definition | Aliases to avoid |
|
|
32
|
+
| ----------- | ------------------------------------------------------- | --------------------- |
|
|
33
|
+
| **Order** | A customer's request to purchase one or more items | Purchase, transaction |
|
|
34
|
+
| **Invoice** | A request for payment sent to a customer after delivery | Bill, payment request |
|
|
35
|
+
|
|
36
|
+
## People
|
|
37
|
+
|
|
38
|
+
| Term | Definition | Aliases to avoid |
|
|
39
|
+
| ------------ | ------------------------------------------- | ---------------------- |
|
|
40
|
+
| **Customer** | A person or organization that places orders | Client, buyer, account |
|
|
41
|
+
| **User** | An authentication identity in the system | Login, account |
|
|
42
|
+
|
|
43
|
+
## Relationships
|
|
44
|
+
|
|
45
|
+
- An **Invoice** belongs to exactly one **Customer**
|
|
46
|
+
- An **Order** produces one or more **Invoices**
|
|
47
|
+
|
|
48
|
+
## Example dialogue
|
|
49
|
+
|
|
50
|
+
> **Dev:** "When a **Customer** places an **Order**, do we create the **Invoice** immediately?"
|
|
51
|
+
> **Domain expert:** "No — an **Invoice** is only generated once a **Fulfillment** is confirmed. A single **Order** can produce multiple **Invoices** if items ship in separate **Shipments**."
|
|
52
|
+
> **Dev:** "So if a **Shipment** is cancelled before dispatch, no **Invoice** exists for it?"
|
|
53
|
+
> **Domain expert:** "Exactly. The **Invoice** lifecycle is tied to the **Fulfillment**, not the **Order**."
|
|
54
|
+
|
|
55
|
+
## Flagged ambiguities
|
|
56
|
+
|
|
57
|
+
- "account" was used to mean both **Customer** and **User** — these are distinct concepts: a **Customer** places orders, while a **User** is an authentication identity that may or may not represent a **Customer**.
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Rules
|
|
61
|
+
|
|
62
|
+
- **Be opinionated.** When multiple words exist for the same concept, pick the best one and list the others as aliases to avoid.
|
|
63
|
+
- **Flag conflicts explicitly.** If a term is used ambiguously in the conversation, call it out in the "Flagged ambiguities" section with a clear recommendation.
|
|
64
|
+
- **Only include terms relevant for domain experts.** Skip the names of modules or classes unless they have meaning in the domain language.
|
|
65
|
+
- **Keep definitions tight.** One sentence max. Define what it IS, not what it does.
|
|
66
|
+
- **Show relationships.** Use bold term names and express cardinality where obvious.
|
|
67
|
+
- **Only include domain terms.** Skip generic programming concepts (array, function, endpoint) unless they have domain-specific meaning.
|
|
68
|
+
- **Group terms into multiple tables** when natural clusters emerge (e.g. by subdomain, lifecycle, or actor). Each group gets its own heading and table. If all terms belong to a single cohesive domain, one table is fine — don't force groupings.
|
|
69
|
+
- **Write an example dialogue.** A short conversation (3-5 exchanges) between a dev and a domain expert that demonstrates how the terms interact naturally. The dialogue should clarify boundaries between related concepts and show terms being used precisely.
|
|
70
|
+
|
|
71
|
+
<example>
|
|
72
|
+
|
|
73
|
+
## Example dialogue
|
|
74
|
+
|
|
75
|
+
> **Dev:** "How do I test the **sync service** without Docker?"
|
|
76
|
+
|
|
77
|
+
> **Domain expert:** "Provide the **filesystem layer** instead of the **Docker layer**. It implements the same **Sandbox service** interface but uses a local directory as the **sandbox**."
|
|
78
|
+
|
|
79
|
+
> **Dev:** "So **sync-in** still creates a **bundle** and unpacks it?"
|
|
80
|
+
|
|
81
|
+
> **Domain expert:** "Exactly. The **sync service** doesn't know which layer it's talking to. It calls `exec` and `copyIn` — the **filesystem layer** just runs those as local shell commands."
|
|
82
|
+
|
|
83
|
+
</example>
|
|
84
|
+
|
|
85
|
+
## Re-running
|
|
86
|
+
|
|
87
|
+
When invoked again in the same conversation:
|
|
88
|
+
|
|
89
|
+
1. Read the existing `UBIQUITOUS_LANGUAGE.md`
|
|
90
|
+
2. Incorporate any new terms from subsequent discussion
|
|
91
|
+
3. Update definitions if understanding has evolved
|
|
92
|
+
4. Re-flag any new ambiguities
|
|
93
|
+
5. Rewrite the example dialogue to incorporate new terms
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ver
|
|
3
|
+
description: 执行版本同步脚本(npm run ver),自动分析 git 提交记录按语义化版本规则升级版本号。当用户说"升级版本""bump version""运行版本同步"或类似含义时触发。
|
|
4
|
+
argument-hint: "可选:手动指定版本号,如 0.2.0"
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# 版本同步 (ver)
|
|
8
|
+
|
|
9
|
+
执行 `scripts/sync-version.js` 版本同步脚本。
|
|
10
|
+
|
|
11
|
+
## 调用方式
|
|
12
|
+
|
|
13
|
+
### 自动分析(默认)
|
|
14
|
+
```
|
|
15
|
+
npm run ver
|
|
16
|
+
```
|
|
17
|
+
- 分析自最近 tag 以来的 git 提交记录
|
|
18
|
+
- 按 Conventional Commits 类型决定升级幅度:BREAKING → major, feat → minor, fix → patch
|
|
19
|
+
- docs/refactor/chore → 不升版
|
|
20
|
+
- 开发分支自动追加 `-dev` 后缀,强制 PATCH 升级,跳过 git tag 和 commit
|
|
21
|
+
- master 分支自动剥离 `-dev` 后缀后分析
|
|
22
|
+
- 同步 `package.json` / `tauri.conf.json` / `Cargo.toml` 三个文件
|
|
23
|
+
- 防重复机制:检查最近提交和 tag 是否已存在
|
|
24
|
+
|
|
25
|
+
### 手动指定版本
|
|
26
|
+
```
|
|
27
|
+
npm run ver -- X.Y.Z
|
|
28
|
+
```
|
|
29
|
+
- 直接设置指定版本号
|
|
30
|
+
- 开发分支自动追加 `-dev` 后缀
|
|
31
|
+
|
|
32
|
+
## 同步的文件
|
|
33
|
+
|
|
34
|
+
| 文件 | 说明 |
|
|
35
|
+
|------|------|
|
|
36
|
+
| `package.json` | `version` 字段 |
|
|
37
|
+
| `src-tauri/tauri.conf.json` | `version` 字段 |
|
|
38
|
+
| `src-tauri/Cargo.toml` | `[package]` 下的 `version` 行 |
|
|
39
|
+
|
|
40
|
+
## 输出说明
|
|
41
|
+
|
|
42
|
+
脚本执行后会打印:
|
|
43
|
+
- 当前分支和版本
|
|
44
|
+
- 提交统计(BREAKING/feat/fix/other)
|
|
45
|
+
- 升降级类型和结果版本
|
|
46
|
+
- 文件同步状态
|
|
47
|
+
- git tag 创建状态(master 分支)
|
|
48
|
+
|
|
49
|
+
## 版本规则
|
|
50
|
+
|
|
51
|
+
| Commit 类型 | 版本变动 |
|
|
52
|
+
|-------------|---------|
|
|
53
|
+
| BREAKING CHANGE | 🔺 major |
|
|
54
|
+
| feat | 🔺 minor |
|
|
55
|
+
| fix | 🔺 patch |
|
|
56
|
+
| docs/refactor/chore | ❌ 不升版 |
|
|
57
|
+
|
|
58
|
+
## 边界行为
|
|
59
|
+
|
|
60
|
+
- 仅 webstorm/idea 提交(`^Merge branch` 等合并提交)不会影响版本
|
|
61
|
+
- 开发分支(非 main/master)仅允许 PATCH 升级,合并到 main 后再完整升版
|
|
62
|
+
- 行尾已统一处理:Cargo.toml → LF,tauri.conf.json → LF,package.json → CRLF(兼容其他工具)
|