@ecology91/skills 0.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/LICENSE +21 -0
- package/README.md +179 -0
- package/bin/install.mjs +52 -0
- package/opencode.json +10 -0
- package/package.json +37 -0
- package/scripts/link-skills.sh +40 -0
- package/scripts/list-skills.sh +7 -0
- package/skills/engineering/README.md +16 -0
- package/skills/engineering/diagnose/SKILL.md +117 -0
- package/skills/engineering/diagnose/scripts/hitl-loop.template.sh +41 -0
- package/skills/engineering/grill-with-docs/ADR-FORMAT.md +47 -0
- package/skills/engineering/grill-with-docs/CONTEXT-FORMAT.md +77 -0
- package/skills/engineering/grill-with-docs/SKILL.md +88 -0
- package/skills/engineering/improve-codebase-architecture/DEEPENING.md +37 -0
- package/skills/engineering/improve-codebase-architecture/INTERFACE-DESIGN.md +44 -0
- package/skills/engineering/improve-codebase-architecture/LANGUAGE.md +53 -0
- package/skills/engineering/improve-codebase-architecture/SKILL.md +71 -0
- package/skills/engineering/prototype/LOGIC.md +79 -0
- package/skills/engineering/prototype/SKILL.md +30 -0
- package/skills/engineering/prototype/UI.md +112 -0
- package/skills/engineering/setup-agent-skills/SKILL.md +128 -0
- package/skills/engineering/setup-agent-skills/domain.md +51 -0
- package/skills/engineering/setup-agent-skills/issue-tracker-beads.md +54 -0
- package/skills/engineering/setup-agent-skills/issue-tracker-github.md +33 -0
- package/skills/engineering/setup-agent-skills/issue-tracker-gitlab.md +34 -0
- package/skills/engineering/setup-agent-skills/issue-tracker-local.md +27 -0
- package/skills/engineering/setup-agent-skills/triage-labels.md +15 -0
- package/skills/engineering/setup-coding-quality-checks/SKILL.md +84 -0
- package/skills/engineering/tdd/SKILL.md +109 -0
- package/skills/engineering/tdd/deep-modules.md +33 -0
- package/skills/engineering/tdd/interface-design.md +31 -0
- package/skills/engineering/tdd/mocking.md +59 -0
- package/skills/engineering/tdd/refactoring.md +10 -0
- package/skills/engineering/tdd/tests.md +61 -0
- package/skills/engineering/to-issues/SKILL.md +99 -0
- package/skills/engineering/to-prd/SKILL.md +76 -0
- package/skills/engineering/to-qa/SKILL.md +45 -0
- package/skills/engineering/triage/AGENT-BRIEF.md +186 -0
- package/skills/engineering/triage/OUT-OF-SCOPE.md +101 -0
- package/skills/engineering/triage/SKILL.md +107 -0
- package/skills/engineering/zoom-out/SKILL.md +7 -0
- package/skills/misc/README.md +8 -0
- package/skills/misc/git-guardrails-opencode/SKILL.md +57 -0
- package/skills/misc/migrate-to-shoehorn/SKILL.md +118 -0
- package/skills/misc/scaffold-exercises/SKILL.md +106 -0
- package/skills/misc/setup-pre-commit/SKILL.md +91 -0
- package/skills/productivity/README.md +8 -0
- package/skills/productivity/caveman/SKILL.md +49 -0
- package/skills/productivity/grill-me/SKILL.md +10 -0
- package/skills/productivity/handoff/SKILL.md +13 -0
- package/skills/productivity/write-a-skill/SKILL.md +117 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ecology9191
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
# Skills For Real Engineers
|
|
2
|
+
|
|
3
|
+
[](https://skills.sh/ecology9191/skills)
|
|
4
|
+
[](https://www.npmjs.com/package/@ecology91/skills)
|
|
5
|
+
|
|
6
|
+
Agent skills for doing real engineering with opencode - not vibe coding.
|
|
7
|
+
|
|
8
|
+
Developing real applications is hard. Approaches like GSD, BMAD, and Spec-Kit try to help by owning the process. But while doing so, they take away your control and make bugs in the process hard to resolve.
|
|
9
|
+
|
|
10
|
+
These skills are designed to be small, easy to adapt, and composable. They work with any model. They're based on decades of engineering experience. Hack around with them. Make them your own. Enjoy.
|
|
11
|
+
|
|
12
|
+
## Quickstart For opencode
|
|
13
|
+
|
|
14
|
+
1. Install the skills into opencode from the fork repo:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npx skills@latest add ecology9191/skills -a opencode
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
2. Or install the published npm package directly:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npx @ecology91/skills
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
3. For local development on this repo, link the checked-out skills into opencode's global skills directory:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
./scripts/link-skills.sh
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
4. Quit and restart opencode so it reloads the skill list.
|
|
33
|
+
|
|
34
|
+
5. Run `/setup-agent-skills` in opencode. It will:
|
|
35
|
+
- Ask you which issue tracker you want to use (GitHub, GitLab, Beads, `.scratch`, or another workflow)
|
|
36
|
+
- Ask you what labels you apply to issues when you triage them (`/triage` uses labels)
|
|
37
|
+
- Ask you where you want to save any docs we create
|
|
38
|
+
|
|
39
|
+
6. Bam - you're ready to go.
|
|
40
|
+
|
|
41
|
+
This repo also includes `opencode.json`, so opencode loads the promoted skill buckets automatically when you open this repo directly.
|
|
42
|
+
|
|
43
|
+
## Why These Skills Exist
|
|
44
|
+
|
|
45
|
+
I built these skills as a way to fix common failure modes I see with opencode, Codex, and other coding agents.
|
|
46
|
+
|
|
47
|
+
### #1: The Agent Didn't Do What I Want
|
|
48
|
+
|
|
49
|
+
> "No-one knows exactly what they want"
|
|
50
|
+
>
|
|
51
|
+
> David Thomas & Andrew Hunt, [The Pragmatic Programmer](https://www.amazon.co.uk/Pragmatic-Programmer-Anniversary-Journey-Mastery/dp/B0833F1T3V)
|
|
52
|
+
|
|
53
|
+
**The Problem**. The most common failure mode in software development is misalignment. You think the dev knows what you want. Then you see what they've built - and you realize it didn't understand you at all.
|
|
54
|
+
|
|
55
|
+
This is just the same in the AI age. There is a communication gap between you and the agent. The fix for this is a **grilling session** - getting the agent to ask you detailed questions about what you're building.
|
|
56
|
+
|
|
57
|
+
**The Fix** is to use:
|
|
58
|
+
|
|
59
|
+
- [`/grill-me`](./skills/productivity/grill-me/SKILL.md) - for non-code uses
|
|
60
|
+
- [`/grill-with-docs`](./skills/engineering/grill-with-docs/SKILL.md) - same as [`/grill-me`](./skills/productivity/grill-me/SKILL.md), but adds more goodies (see below)
|
|
61
|
+
|
|
62
|
+
These are my most popular skills. They help you align with the agent before you get started, and think deeply about the change you're making. Use them _every_ time you want to make a change.
|
|
63
|
+
|
|
64
|
+
### #2: The Agent Is Way Too Verbose
|
|
65
|
+
|
|
66
|
+
> With a ubiquitous language, conversations among developers and expressions of the code are all derived from the same domain model.
|
|
67
|
+
>
|
|
68
|
+
> Eric Evans, [Domain-Driven-Design](https://www.amazon.co.uk/Domain-Driven-Design-Tackling-Complexity-Software/dp/0321125215)
|
|
69
|
+
|
|
70
|
+
**The Problem**: At the start of a project, devs and the people they're building the software for (the domain experts) are usually speaking different languages.
|
|
71
|
+
|
|
72
|
+
I felt the same tension with my agents. Agents are usually dropped into a project and asked to figure out the jargon as they go. So they use 20 words where 1 will do.
|
|
73
|
+
|
|
74
|
+
**The Fix** for this is a shared language. It's a document that helps agents decode the jargon used in the project.
|
|
75
|
+
|
|
76
|
+
<details>
|
|
77
|
+
<summary>
|
|
78
|
+
Example
|
|
79
|
+
</summary>
|
|
80
|
+
|
|
81
|
+
Here's a before-and-after example. Which one is easier to read?
|
|
82
|
+
|
|
83
|
+
- **BEFORE**: "There's a problem when a lesson inside a section of a course is made 'real' (i.e. given a spot in the file system)"
|
|
84
|
+
- **AFTER**: "There's a problem with the materialization cascade"
|
|
85
|
+
|
|
86
|
+
This concision pays off session after session.
|
|
87
|
+
|
|
88
|
+
</details>
|
|
89
|
+
|
|
90
|
+
This is built into [`/grill-with-docs`](./skills/engineering/grill-with-docs/SKILL.md). It's a grilling session, but that helps you build a shared language with the AI, and document hard-to-explain decisions in ADR's.
|
|
91
|
+
|
|
92
|
+
It's hard to explain how powerful this is. It might be the single coolest technique in this repo. Try it, and see.
|
|
93
|
+
|
|
94
|
+
> [!TIP]
|
|
95
|
+
> A shared language has many other benefits than reducing verbosity:
|
|
96
|
+
>
|
|
97
|
+
> - **Variables, functions and files are named consistently**, using the shared language
|
|
98
|
+
> - As a result, the **codebase is easier to navigate** for the agent
|
|
99
|
+
> - The agent also **spends fewer tokens on thinking**, because it has access to a more concise language
|
|
100
|
+
|
|
101
|
+
### #3: The Code Doesn't Work
|
|
102
|
+
|
|
103
|
+
> "Always take small, deliberate steps. The rate of feedback is your speed limit. Never take on a task that’s too big."
|
|
104
|
+
>
|
|
105
|
+
> David Thomas & Andrew Hunt, [The Pragmatic Programmer](https://www.amazon.co.uk/Pragmatic-Programmer-Anniversary-Journey-Mastery/dp/B0833F1T3V)
|
|
106
|
+
|
|
107
|
+
**The Problem**: Let's say that you and the agent are aligned on what to build. What happens when the agent _still_ produces crap?
|
|
108
|
+
|
|
109
|
+
It's time to look at your feedback loops. Without feedback on how the code it produces actually runs, the agent will be flying blind.
|
|
110
|
+
|
|
111
|
+
**The Fix**: You need the usual tranche of feedback loops: static types, browser access, and automated tests.
|
|
112
|
+
|
|
113
|
+
For automated tests, a red-green-refactor loop is critical. This is where the agent writes a failing test first, then fixes the test. This helps give the agent a consistent level of feedback that results in far better code.
|
|
114
|
+
|
|
115
|
+
I've built a **[`/tdd`](./skills/engineering/tdd/SKILL.md) skill** you can slot into any project. It encourages red-green-refactor and gives the agent plenty of guidance on what makes good and bad tests.
|
|
116
|
+
|
|
117
|
+
For debugging, I've also built a **[`/diagnose`](./skills/engineering/diagnose/SKILL.md)** skill that wraps best debugging practices into a simple loop.
|
|
118
|
+
|
|
119
|
+
### #4: We Built A Ball Of Mud
|
|
120
|
+
|
|
121
|
+
> "Invest in the design of the system _every day_."
|
|
122
|
+
>
|
|
123
|
+
> Kent Beck, [Extreme Programming Explained](https://www.amazon.co.uk/Extreme-Programming-Explained-Embrace-Change/dp/0321278658)
|
|
124
|
+
|
|
125
|
+
> "The best modules are deep. They allow a lot of functionality to be accessed through a simple interface."
|
|
126
|
+
>
|
|
127
|
+
> John Ousterhout, [A Philosophy Of Software Design](https://www.amazon.co.uk/Philosophy-Software-Design-2nd/dp/173210221X)
|
|
128
|
+
|
|
129
|
+
**The Problem**: Most apps built with agents are complex and hard to change. Because agents can radically speed up coding, they also accelerate software entropy. Codebases get more complex at an unprecedented rate.
|
|
130
|
+
|
|
131
|
+
**The Fix** for this is a radical new approach to AI-powered development: caring about the design of the code.
|
|
132
|
+
|
|
133
|
+
This is built in to every layer of these skills:
|
|
134
|
+
|
|
135
|
+
- [`/to-prd`](./skills/engineering/to-prd/SKILL.md) quizzes you about which modules you're touching before creating a PRD
|
|
136
|
+
- [`/zoom-out`](./skills/engineering/zoom-out/SKILL.md) tells the agent to explain code in the context of the whole system
|
|
137
|
+
|
|
138
|
+
And crucially, [`/improve-codebase-architecture`](./skills/engineering/improve-codebase-architecture/SKILL.md) helps you rescue a codebase that has become a ball of mud. I recommend running it on your codebase once every few days.
|
|
139
|
+
|
|
140
|
+
### Summary
|
|
141
|
+
|
|
142
|
+
Software engineering fundamentals matter more than ever. These skills are my best effort at condensing these fundamentals into repeatable practices, to help you ship the best apps of your career. Enjoy.
|
|
143
|
+
|
|
144
|
+
## Reference
|
|
145
|
+
|
|
146
|
+
### Engineering
|
|
147
|
+
|
|
148
|
+
Skills I use daily for code work.
|
|
149
|
+
|
|
150
|
+
- **[diagnose](./skills/engineering/diagnose/SKILL.md)** — Disciplined diagnosis loop for hard bugs and performance regressions: reproduce → minimise → hypothesise → instrument → fix → regression-test.
|
|
151
|
+
- **[grill-with-docs](./skills/engineering/grill-with-docs/SKILL.md)** — Grilling session that challenges your plan against the existing domain model, sharpens terminology, and updates `CONTEXT.md` and ADRs inline.
|
|
152
|
+
- **[triage](./skills/engineering/triage/SKILL.md)** — Triage issues through a state machine of triage roles.
|
|
153
|
+
- **[improve-codebase-architecture](./skills/engineering/improve-codebase-architecture/SKILL.md)** — Find deepening opportunities in a codebase, informed by the domain language in `CONTEXT.md` and the decisions in `docs/adr/`.
|
|
154
|
+
- **[setup-coding-quality-checks](./skills/engineering/setup-coding-quality-checks/SKILL.md)** — Set up strict local formatters, linters, typechecks, tests, scanners, and git hooks that make agent coding safer.
|
|
155
|
+
- **[setup-agent-skills](./skills/engineering/setup-agent-skills/SKILL.md)** — Scaffold the per-repo config (issue tracker, triage label vocabulary, domain doc layout) that the other engineering skills consume. Run once per repo before using `to-issues`, `to-prd`, `to-qa`, `triage`, `diagnose`, `tdd`, `improve-codebase-architecture`, or `zoom-out`.
|
|
156
|
+
- **[tdd](./skills/engineering/tdd/SKILL.md)** — Test-driven development with a red-green-refactor loop. Builds features or fixes bugs one vertical slice at a time.
|
|
157
|
+
- **[to-issues](./skills/engineering/to-issues/SKILL.md)** — Break any plan, spec, or PRD into independently-grabbable issues on the project issue tracker using vertical slices.
|
|
158
|
+
- **[to-prd](./skills/engineering/to-prd/SKILL.md)** — Turn the current conversation context into a PRD and submit it to the project issue tracker. No interview — just synthesizes what you've already discussed.
|
|
159
|
+
- **[to-qa](./skills/engineering/to-qa/SKILL.md)** — Create a local QA To Do session from completed child work under an explicit parent issue.
|
|
160
|
+
- **[zoom-out](./skills/engineering/zoom-out/SKILL.md)** — Tell the agent to zoom out and give broader context or a higher-level perspective on an unfamiliar section of code.
|
|
161
|
+
- **[prototype](./skills/engineering/prototype/SKILL.md)** — Build a throwaway prototype to flesh out a design — either a runnable terminal app for state/business-logic questions, or several radically different UI variations toggleable from one route.
|
|
162
|
+
|
|
163
|
+
### Productivity
|
|
164
|
+
|
|
165
|
+
General workflow tools, not code-specific.
|
|
166
|
+
|
|
167
|
+
- **[caveman](./skills/productivity/caveman/SKILL.md)** — Ultra-compressed communication mode. Cuts token usage ~75% by dropping filler while keeping full technical accuracy.
|
|
168
|
+
- **[grill-me](./skills/productivity/grill-me/SKILL.md)** — Get relentlessly interviewed about a plan or design until every branch of the decision tree is resolved.
|
|
169
|
+
- **[handoff](./skills/productivity/handoff/SKILL.md)** — Compact the current conversation into a handoff document so another agent can continue the work.
|
|
170
|
+
- **[write-a-skill](./skills/productivity/write-a-skill/SKILL.md)** — Create new skills with proper structure, progressive disclosure, and bundled resources.
|
|
171
|
+
|
|
172
|
+
### Misc
|
|
173
|
+
|
|
174
|
+
Tools I keep around but rarely use.
|
|
175
|
+
|
|
176
|
+
- **[git-guardrails-opencode](./skills/misc/git-guardrails-opencode/SKILL.md)** — Set up opencode permissions to block dangerous git commands (push, reset --hard, clean, etc.) before they execute.
|
|
177
|
+
- **[migrate-to-shoehorn](./skills/misc/migrate-to-shoehorn/SKILL.md)** — Migrate test files from `as` type assertions to @total-typescript/shoehorn.
|
|
178
|
+
- **[scaffold-exercises](./skills/misc/scaffold-exercises/SKILL.md)** — Create exercise directory structures with sections, problems, solutions, and explainers.
|
|
179
|
+
- **[setup-pre-commit](./skills/misc/setup-pre-commit/SKILL.md)** — Set up Husky pre-commit hooks with lint-staged, Prettier, type checking, and tests.
|
package/bin/install.mjs
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import fs from "node:fs";
|
|
3
|
+
import os from "node:os";
|
|
4
|
+
import path from "node:path";
|
|
5
|
+
import { fileURLToPath } from "node:url";
|
|
6
|
+
|
|
7
|
+
const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..");
|
|
8
|
+
const buckets = ["engineering", "productivity", "misc"];
|
|
9
|
+
const args = new Set(process.argv.slice(2));
|
|
10
|
+
|
|
11
|
+
if (args.has("--help") || args.has("-h")) {
|
|
12
|
+
console.log(`Usage: npx @ecology91/skills [--dry-run]\n\nCopies promoted skills into ~/.config/opencode/skills.`);
|
|
13
|
+
process.exit(0);
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
const dryRun = args.has("--dry-run");
|
|
17
|
+
const destRoot = path.join(os.homedir(), ".config", "opencode", "skills");
|
|
18
|
+
|
|
19
|
+
function copySkill(src, dest) {
|
|
20
|
+
if (dryRun) {
|
|
21
|
+
console.log(`would install ${path.basename(src)} -> ${dest}`);
|
|
22
|
+
return;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
fs.rmSync(dest, { recursive: true, force: true });
|
|
26
|
+
fs.mkdirSync(path.dirname(dest), { recursive: true });
|
|
27
|
+
fs.cpSync(src, dest, { recursive: true, force: true });
|
|
28
|
+
console.log(`installed ${path.basename(src)} -> ${dest}`);
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
const skills = [];
|
|
32
|
+
|
|
33
|
+
for (const bucket of buckets) {
|
|
34
|
+
const bucketDir = path.join(root, "skills", bucket);
|
|
35
|
+
if (!fs.existsSync(bucketDir)) continue;
|
|
36
|
+
|
|
37
|
+
for (const entry of fs.readdirSync(bucketDir, { withFileTypes: true })) {
|
|
38
|
+
if (!entry.isDirectory()) continue;
|
|
39
|
+
|
|
40
|
+
const src = path.join(bucketDir, entry.name);
|
|
41
|
+
if (!fs.existsSync(path.join(src, "SKILL.md"))) continue;
|
|
42
|
+
|
|
43
|
+
skills.push([src, path.join(destRoot, entry.name)]);
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
if (!dryRun) fs.mkdirSync(destRoot, { recursive: true });
|
|
48
|
+
|
|
49
|
+
for (const [src, dest] of skills) copySkill(src, dest);
|
|
50
|
+
|
|
51
|
+
console.log(`${dryRun ? "Checked" : "Installed"} ${skills.length} skills for opencode.`);
|
|
52
|
+
console.log("Restart opencode to reload the skill list.");
|
package/opencode.json
ADDED
package/package.json
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@ecology91/skills",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "opencode agent skills for real engineering workflows.",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"type": "module",
|
|
7
|
+
"bin": "./bin/install.mjs",
|
|
8
|
+
"files": [
|
|
9
|
+
"bin/",
|
|
10
|
+
"scripts/",
|
|
11
|
+
"skills/engineering/",
|
|
12
|
+
"skills/productivity/",
|
|
13
|
+
"skills/misc/",
|
|
14
|
+
"opencode.json",
|
|
15
|
+
"README.md",
|
|
16
|
+
"LICENSE"
|
|
17
|
+
],
|
|
18
|
+
"repository": {
|
|
19
|
+
"type": "git",
|
|
20
|
+
"url": "git+https://github.com/ecology9191/skills.git"
|
|
21
|
+
},
|
|
22
|
+
"bugs": {
|
|
23
|
+
"url": "https://github.com/ecology9191/skills/issues"
|
|
24
|
+
},
|
|
25
|
+
"homepage": "https://github.com/ecology9191/skills#readme",
|
|
26
|
+
"keywords": [
|
|
27
|
+
"agent-skills",
|
|
28
|
+
"opencode",
|
|
29
|
+
"skills",
|
|
30
|
+
"ai-agents",
|
|
31
|
+
"sandcastle",
|
|
32
|
+
"ralph"
|
|
33
|
+
],
|
|
34
|
+
"publishConfig": {
|
|
35
|
+
"access": "public"
|
|
36
|
+
}
|
|
37
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
set -euo pipefail
|
|
3
|
+
|
|
4
|
+
# Links promoted skills in the repository to opencode's global skills
|
|
5
|
+
# directory, so they can be used from any opencode project.
|
|
6
|
+
|
|
7
|
+
REPO="$(cd "$(dirname "$0")/.." && pwd)"
|
|
8
|
+
DEST="$HOME/.config/opencode/skills"
|
|
9
|
+
|
|
10
|
+
# If the destination is a symlink that resolves into this repo, we'd end up
|
|
11
|
+
# writing the per-skill symlinks back into the repo's own skills/ tree. Detect
|
|
12
|
+
# and bail out instead of polluting the working copy.
|
|
13
|
+
if [ -L "$DEST" ]; then
|
|
14
|
+
resolved="$(readlink -f "$DEST")"
|
|
15
|
+
case "$resolved" in
|
|
16
|
+
"$REPO"|"$REPO"/*)
|
|
17
|
+
echo "error: $DEST is a symlink into this repo ($resolved)." >&2
|
|
18
|
+
echo "Remove it (rm \"$DEST\") and re-run; the script will recreate it as a real dir." >&2
|
|
19
|
+
exit 1
|
|
20
|
+
;;
|
|
21
|
+
esac
|
|
22
|
+
fi
|
|
23
|
+
|
|
24
|
+
mkdir -p "$DEST"
|
|
25
|
+
|
|
26
|
+
for bucket in engineering productivity misc; do
|
|
27
|
+
find "$REPO/skills/$bucket" -name SKILL.md -not -path '*/node_modules/*' -print0
|
|
28
|
+
done |
|
|
29
|
+
while IFS= read -r -d '' skill_md; do
|
|
30
|
+
src="$(dirname "$skill_md")"
|
|
31
|
+
name="$(basename "$src")"
|
|
32
|
+
target="$DEST/$name"
|
|
33
|
+
|
|
34
|
+
if [ -e "$target" ] && [ ! -L "$target" ]; then
|
|
35
|
+
rm -rf "$target"
|
|
36
|
+
fi
|
|
37
|
+
|
|
38
|
+
ln -sfn "$src" "$target"
|
|
39
|
+
echo "linked $name -> $src"
|
|
40
|
+
done
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Engineering
|
|
2
|
+
|
|
3
|
+
Skills I use daily for code work.
|
|
4
|
+
|
|
5
|
+
- **[diagnose](./diagnose/SKILL.md)** — Disciplined diagnosis loop for hard bugs and performance regressions: reproduce → minimise → hypothesise → instrument → fix → regression-test.
|
|
6
|
+
- **[grill-with-docs](./grill-with-docs/SKILL.md)** — Grilling session that challenges your plan against the existing domain model, sharpens terminology, and updates `CONTEXT.md` and ADRs inline.
|
|
7
|
+
- **[triage](./triage/SKILL.md)** — Triage issues through a state machine of triage roles.
|
|
8
|
+
- **[improve-codebase-architecture](./improve-codebase-architecture/SKILL.md)** — Find deepening opportunities in a codebase, informed by the domain language in `CONTEXT.md` and the decisions in `docs/adr/`.
|
|
9
|
+
- **[setup-coding-quality-checks](./setup-coding-quality-checks/SKILL.md)** — Set up strict local formatters, linters, typechecks, tests, scanners, and git hooks that make agent coding safer.
|
|
10
|
+
- **[setup-agent-skills](./setup-agent-skills/SKILL.md)** — Scaffold the per-repo config (issue tracker, triage label vocabulary, domain doc layout) that the other engineering skills consume.
|
|
11
|
+
- **[tdd](./tdd/SKILL.md)** — Test-driven development with a red-green-refactor loop. Builds features or fixes bugs one vertical slice at a time.
|
|
12
|
+
- **[to-issues](./to-issues/SKILL.md)** — Break any plan, spec, or PRD into independently-grabbable issues on the project issue tracker using vertical slices.
|
|
13
|
+
- **[to-prd](./to-prd/SKILL.md)** — Turn the current conversation context into a PRD and submit it to the project issue tracker.
|
|
14
|
+
- **[to-qa](./to-qa/SKILL.md)** — Create a local QA To Do session from completed child work under an explicit parent issue.
|
|
15
|
+
- **[zoom-out](./zoom-out/SKILL.md)** — Tell the agent to zoom out and give broader context or a higher-level perspective on an unfamiliar section of code.
|
|
16
|
+
- **[prototype](./prototype/SKILL.md)** — Build a throwaway prototype to flesh out a design — either a runnable terminal app for state/business-logic questions, or several radically different UI variations toggleable from one route.
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: diagnose
|
|
3
|
+
description: Disciplined diagnosis loop for hard bugs and performance regressions. Reproduce → minimise → hypothesise → instrument → fix → regression-test. Use when user says "diagnose this" / "debug this", reports a bug, says something is broken/throwing/failing, or describes a performance regression.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Diagnose
|
|
7
|
+
|
|
8
|
+
A discipline for hard bugs. Skip phases only when explicitly justified.
|
|
9
|
+
|
|
10
|
+
When exploring the codebase, use the project's domain glossary to get a clear mental model of the relevant modules, and check ADRs in the area you're touching.
|
|
11
|
+
|
|
12
|
+
## Phase 1 — Build a feedback loop
|
|
13
|
+
|
|
14
|
+
**This is the skill.** Everything else is mechanical. If you have a fast, deterministic, agent-runnable pass/fail signal for the bug, you will find the cause — bisection, hypothesis-testing, and instrumentation all just consume that signal. If you don't have one, no amount of staring at code will save you.
|
|
15
|
+
|
|
16
|
+
Spend disproportionate effort here. **Be aggressive. Be creative. Refuse to give up.**
|
|
17
|
+
|
|
18
|
+
### Ways to construct one — try them in roughly this order
|
|
19
|
+
|
|
20
|
+
1. **Failing test** at whatever seam reaches the bug — unit, integration, e2e.
|
|
21
|
+
2. **Curl / HTTP script** against a running dev server.
|
|
22
|
+
3. **CLI invocation** with a fixture input, diffing stdout against a known-good snapshot.
|
|
23
|
+
4. **Headless browser script** (Playwright / Puppeteer) — drives the UI, asserts on DOM/console/network.
|
|
24
|
+
5. **Replay a captured trace.** Save a real network request / payload / event log to disk; replay it through the code path in isolation.
|
|
25
|
+
6. **Throwaway harness.** Spin up a minimal subset of the system (one service, mocked deps) that exercises the bug code path with a single function call.
|
|
26
|
+
7. **Property / fuzz loop.** If the bug is "sometimes wrong output", run 1000 random inputs and look for the failure mode.
|
|
27
|
+
8. **Bisection harness.** If the bug appeared between two known states (commit, dataset, version), automate "boot at state X, check, repeat" so you can `git bisect run` it.
|
|
28
|
+
9. **Differential loop.** Run the same input through old-version vs new-version (or two configs) and diff outputs.
|
|
29
|
+
10. **HITL bash script.** Last resort. If a human must click, drive _them_ with `scripts/hitl-loop.template.sh` so the loop is still structured. Captured output feeds back to you.
|
|
30
|
+
|
|
31
|
+
Build the right feedback loop, and the bug is 90% fixed.
|
|
32
|
+
|
|
33
|
+
### Iterate on the loop itself
|
|
34
|
+
|
|
35
|
+
Treat the loop as a product. Once you have _a_ loop, ask:
|
|
36
|
+
|
|
37
|
+
- Can I make it faster? (Cache setup, skip unrelated init, narrow the test scope.)
|
|
38
|
+
- Can I make the signal sharper? (Assert on the specific symptom, not "didn't crash".)
|
|
39
|
+
- Can I make it more deterministic? (Pin time, seed RNG, isolate filesystem, freeze network.)
|
|
40
|
+
|
|
41
|
+
A 30-second flaky loop is barely better than no loop. A 2-second deterministic loop is a debugging superpower.
|
|
42
|
+
|
|
43
|
+
### Non-deterministic bugs
|
|
44
|
+
|
|
45
|
+
The goal is not a clean repro but a **higher reproduction rate**. Loop the trigger 100×, parallelise, add stress, narrow timing windows, inject sleeps. A 50%-flake bug is debuggable; 1% is not — keep raising the rate until it's debuggable.
|
|
46
|
+
|
|
47
|
+
### When you genuinely cannot build a loop
|
|
48
|
+
|
|
49
|
+
Stop and say so explicitly. List what you tried. Ask the user for: (a) access to whatever environment reproduces it, (b) a captured artifact (HAR file, log dump, core dump, screen recording with timestamps), or (c) permission to add temporary production instrumentation. Do **not** proceed to hypothesise without a loop.
|
|
50
|
+
|
|
51
|
+
Do not proceed to Phase 2 until you have a loop you believe in.
|
|
52
|
+
|
|
53
|
+
## Phase 2 — Reproduce
|
|
54
|
+
|
|
55
|
+
Run the loop. Watch the bug appear.
|
|
56
|
+
|
|
57
|
+
Confirm:
|
|
58
|
+
|
|
59
|
+
- [ ] The loop produces the failure mode the **user** described — not a different failure that happens to be nearby. Wrong bug = wrong fix.
|
|
60
|
+
- [ ] The failure is reproducible across multiple runs (or, for non-deterministic bugs, reproducible at a high enough rate to debug against).
|
|
61
|
+
- [ ] You have captured the exact symptom (error message, wrong output, slow timing) so later phases can verify the fix actually addresses it.
|
|
62
|
+
|
|
63
|
+
Do not proceed until you reproduce the bug.
|
|
64
|
+
|
|
65
|
+
## Phase 3 — Hypothesise
|
|
66
|
+
|
|
67
|
+
Generate **3–5 ranked hypotheses** before testing any of them. Single-hypothesis generation anchors on the first plausible idea.
|
|
68
|
+
|
|
69
|
+
Each hypothesis must be **falsifiable**: state the prediction it makes.
|
|
70
|
+
|
|
71
|
+
> Format: "If <X> is the cause, then <changing Y> will make the bug disappear / <changing Z> will make it worse."
|
|
72
|
+
|
|
73
|
+
If you cannot state the prediction, the hypothesis is a vibe — discard or sharpen it.
|
|
74
|
+
|
|
75
|
+
**Show the ranked list to the user before testing.** They often have domain knowledge that re-ranks instantly ("we just deployed a change to #3"), or know hypotheses they've already ruled out. Cheap checkpoint, big time saver. Don't block on it — proceed with your ranking if the user is AFK.
|
|
76
|
+
|
|
77
|
+
## Phase 4 — Instrument
|
|
78
|
+
|
|
79
|
+
Each probe must map to a specific prediction from Phase 3. **Change one variable at a time.**
|
|
80
|
+
|
|
81
|
+
Tool preference:
|
|
82
|
+
|
|
83
|
+
1. **Debugger / REPL inspection** if the env supports it. One breakpoint beats ten logs.
|
|
84
|
+
2. **Targeted logs** at the boundaries that distinguish hypotheses.
|
|
85
|
+
3. Never "log everything and grep".
|
|
86
|
+
|
|
87
|
+
**Tag every debug log** with a unique prefix, e.g. `[DEBUG-a4f2]`. Cleanup at the end becomes a single grep. Untagged logs survive; tagged logs die.
|
|
88
|
+
|
|
89
|
+
**Perf branch.** For performance regressions, logs are usually wrong. Instead: establish a baseline measurement (timing harness, `performance.now()`, profiler, query plan), then bisect. Measure first, fix second.
|
|
90
|
+
|
|
91
|
+
## Phase 5 — Fix + regression test
|
|
92
|
+
|
|
93
|
+
Write the regression test **before the fix** — but only if there is a **correct seam** for it.
|
|
94
|
+
|
|
95
|
+
A correct seam is one where the test exercises the **real bug pattern** as it occurs at the call site. If the only available seam is too shallow (single-caller test when the bug needs multiple callers, unit test that can't replicate the chain that triggered the bug), a regression test there gives false confidence.
|
|
96
|
+
|
|
97
|
+
**If no correct seam exists, that itself is the finding.** Note it. The codebase architecture is preventing the bug from being locked down. Flag this for the next phase.
|
|
98
|
+
|
|
99
|
+
If a correct seam exists:
|
|
100
|
+
|
|
101
|
+
1. Turn the minimised repro into a failing test at that seam.
|
|
102
|
+
2. Watch it fail.
|
|
103
|
+
3. Apply the fix.
|
|
104
|
+
4. Watch it pass.
|
|
105
|
+
5. Re-run the Phase 1 feedback loop against the original (un-minimised) scenario.
|
|
106
|
+
|
|
107
|
+
## Phase 6 — Cleanup + post-mortem
|
|
108
|
+
|
|
109
|
+
Required before declaring done:
|
|
110
|
+
|
|
111
|
+
- [ ] Original repro no longer reproduces (re-run the Phase 1 loop)
|
|
112
|
+
- [ ] Regression test passes (or absence of seam is documented)
|
|
113
|
+
- [ ] All `[DEBUG-...]` instrumentation removed (`grep` the prefix)
|
|
114
|
+
- [ ] Throwaway prototypes deleted (or moved to a clearly-marked debug location)
|
|
115
|
+
- [ ] The hypothesis that turned out correct is stated in the commit / PR message — so the next debugger learns
|
|
116
|
+
|
|
117
|
+
**Then ask: what would have prevented this bug?** If the answer involves architectural change (no good test seam, tangled callers, hidden coupling) hand off to the `/improve-codebase-architecture` skill with the specifics. Make the recommendation **after** the fix is in, not before — you have more information now than when you started.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
# Human-in-the-loop reproduction loop.
|
|
3
|
+
# Copy this file, edit the steps below, and run it.
|
|
4
|
+
# The agent runs the script; the user follows prompts in their terminal.
|
|
5
|
+
#
|
|
6
|
+
# Usage:
|
|
7
|
+
# bash hitl-loop.template.sh
|
|
8
|
+
#
|
|
9
|
+
# Two helpers:
|
|
10
|
+
# step "<instruction>" → show instruction, wait for Enter
|
|
11
|
+
# capture VAR "<question>" → show question, read response into VAR
|
|
12
|
+
#
|
|
13
|
+
# At the end, captured values are printed as KEY=VALUE for the agent to parse.
|
|
14
|
+
|
|
15
|
+
set -euo pipefail
|
|
16
|
+
|
|
17
|
+
step() {
|
|
18
|
+
printf '\n>>> %s\n' "$1"
|
|
19
|
+
read -r -p " [Enter when done] " _
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
capture() {
|
|
23
|
+
local var="$1" question="$2" answer
|
|
24
|
+
printf '\n>>> %s\n' "$question"
|
|
25
|
+
read -r -p " > " answer
|
|
26
|
+
printf -v "$var" '%s' "$answer"
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
# --- edit below ---------------------------------------------------------
|
|
30
|
+
|
|
31
|
+
step "Open the app at http://localhost:3000 and sign in."
|
|
32
|
+
|
|
33
|
+
capture ERRORED "Click the 'Export' button. Did it throw an error? (y/n)"
|
|
34
|
+
|
|
35
|
+
capture ERROR_MSG "Paste the error message (or 'none'):"
|
|
36
|
+
|
|
37
|
+
# --- edit above ---------------------------------------------------------
|
|
38
|
+
|
|
39
|
+
printf '\n--- Captured ---\n'
|
|
40
|
+
printf 'ERRORED=%s\n' "$ERRORED"
|
|
41
|
+
printf 'ERROR_MSG=%s\n' "$ERROR_MSG"
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# ADR Format
|
|
2
|
+
|
|
3
|
+
ADRs live in `docs/adr/` and use sequential numbering: `0001-slug.md`, `0002-slug.md`, etc.
|
|
4
|
+
|
|
5
|
+
Create the `docs/adr/` directory lazily — only when the first ADR is needed.
|
|
6
|
+
|
|
7
|
+
## Template
|
|
8
|
+
|
|
9
|
+
```md
|
|
10
|
+
# {Short title of the decision}
|
|
11
|
+
|
|
12
|
+
{1-3 sentences: what's the context, what did we decide, and why.}
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
That's it. An ADR can be a single paragraph. The value is in recording *that* a decision was made and *why* — not in filling out sections.
|
|
16
|
+
|
|
17
|
+
## Optional sections
|
|
18
|
+
|
|
19
|
+
Only include these when they add genuine value. Most ADRs won't need them.
|
|
20
|
+
|
|
21
|
+
- **Status** frontmatter (`proposed | accepted | deprecated | superseded by ADR-NNNN`) — useful when decisions are revisited
|
|
22
|
+
- **Considered Options** — only when the rejected alternatives are worth remembering
|
|
23
|
+
- **Consequences** — only when non-obvious downstream effects need to be called out
|
|
24
|
+
|
|
25
|
+
## Numbering
|
|
26
|
+
|
|
27
|
+
Scan `docs/adr/` for the highest existing number and increment by one.
|
|
28
|
+
|
|
29
|
+
## When to offer an ADR
|
|
30
|
+
|
|
31
|
+
All three of these must be true:
|
|
32
|
+
|
|
33
|
+
1. **Hard to reverse** — the cost of changing your mind later is meaningful
|
|
34
|
+
2. **Surprising without context** — a future reader will look at the code and wonder "why on earth did they do it this way?"
|
|
35
|
+
3. **The result of a real trade-off** — there were genuine alternatives and you picked one for specific reasons
|
|
36
|
+
|
|
37
|
+
If a decision is easy to reverse, skip it — you'll just reverse it. If it's not surprising, nobody will wonder why. If there was no real alternative, there's nothing to record beyond "we did the obvious thing."
|
|
38
|
+
|
|
39
|
+
### What qualifies
|
|
40
|
+
|
|
41
|
+
- **Architectural shape.** "We're using a monorepo." "The write model is event-sourced, the read model is projected into Postgres."
|
|
42
|
+
- **Integration patterns between contexts.** "Ordering and Billing communicate via domain events, not synchronous HTTP."
|
|
43
|
+
- **Technology choices that carry lock-in.** Database, message bus, auth provider, deployment target. Not every library — just the ones that would take a quarter to swap out.
|
|
44
|
+
- **Boundary and scope decisions.** "Customer data is owned by the Customer context; other contexts reference it by ID only." The explicit no-s are as valuable as the yes-s.
|
|
45
|
+
- **Deliberate deviations from the obvious path.** "We're using manual SQL instead of an ORM because X." Anything where a reasonable reader would assume the opposite. These stop the next engineer from "fixing" something that was deliberate.
|
|
46
|
+
- **Constraints not visible in the code.** "We can't use AWS because of compliance requirements." "Response times must be under 200ms because of the partner API contract."
|
|
47
|
+
- **Rejected alternatives when the rejection is non-obvious.** If you considered GraphQL and picked REST for subtle reasons, record it — otherwise someone will suggest GraphQL again in six months.
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# CONTEXT.md Format
|
|
2
|
+
|
|
3
|
+
## Structure
|
|
4
|
+
|
|
5
|
+
```md
|
|
6
|
+
# {Context Name}
|
|
7
|
+
|
|
8
|
+
{One or two sentence description of what this context is and why it exists.}
|
|
9
|
+
|
|
10
|
+
## Language
|
|
11
|
+
|
|
12
|
+
**Order**:
|
|
13
|
+
{A concise description of the term}
|
|
14
|
+
_Avoid_: Purchase, transaction
|
|
15
|
+
|
|
16
|
+
**Invoice**:
|
|
17
|
+
A request for payment sent to a customer after delivery.
|
|
18
|
+
_Avoid_: Bill, payment request
|
|
19
|
+
|
|
20
|
+
**Customer**:
|
|
21
|
+
A person or organization that places orders.
|
|
22
|
+
_Avoid_: Client, buyer, account
|
|
23
|
+
|
|
24
|
+
## Relationships
|
|
25
|
+
|
|
26
|
+
- An **Order** produces one or more **Invoices**
|
|
27
|
+
- An **Invoice** belongs to exactly one **Customer**
|
|
28
|
+
|
|
29
|
+
## Example dialogue
|
|
30
|
+
|
|
31
|
+
> **Dev:** "When a **Customer** places an **Order**, do we create the **Invoice** immediately?"
|
|
32
|
+
> **Domain expert:** "No — an **Invoice** is only generated once a **Fulfillment** is confirmed."
|
|
33
|
+
|
|
34
|
+
## Flagged ambiguities
|
|
35
|
+
|
|
36
|
+
- "account" was used to mean both **Customer** and **User** — resolved: these are distinct concepts.
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Rules
|
|
40
|
+
|
|
41
|
+
- **Be opinionated.** When multiple words exist for the same concept, pick the best one and list the others as aliases to avoid.
|
|
42
|
+
- **Flag conflicts explicitly.** If a term is used ambiguously, call it out in "Flagged ambiguities" with a clear resolution.
|
|
43
|
+
- **Keep definitions tight.** One sentence max. Define what it IS, not what it does.
|
|
44
|
+
- **Show relationships.** Use bold term names and express cardinality where obvious.
|
|
45
|
+
- **Only include terms specific to this project's context.** General programming concepts (timeouts, error types, utility patterns) don't belong even if the project uses them extensively. Before adding a term, ask: is this a concept unique to this context, or a general programming concept? Only the former belongs.
|
|
46
|
+
- **Group terms under subheadings** when natural clusters emerge. If all terms belong to a single cohesive area, a flat list is fine.
|
|
47
|
+
- **Write an example dialogue.** A conversation between a dev and a domain expert that demonstrates how the terms interact naturally and clarifies boundaries between related concepts.
|
|
48
|
+
|
|
49
|
+
## Single vs multi-context repos
|
|
50
|
+
|
|
51
|
+
**Single context (most repos):** One `CONTEXT.md` at the repo root.
|
|
52
|
+
|
|
53
|
+
**Multiple contexts:** A `CONTEXT-MAP.md` at the repo root lists the contexts, where they live, and how they relate to each other:
|
|
54
|
+
|
|
55
|
+
```md
|
|
56
|
+
# Context Map
|
|
57
|
+
|
|
58
|
+
## Contexts
|
|
59
|
+
|
|
60
|
+
- [Ordering](./src/ordering/CONTEXT.md) — receives and tracks customer orders
|
|
61
|
+
- [Billing](./src/billing/CONTEXT.md) — generates invoices and processes payments
|
|
62
|
+
- [Fulfillment](./src/fulfillment/CONTEXT.md) — manages warehouse picking and shipping
|
|
63
|
+
|
|
64
|
+
## Relationships
|
|
65
|
+
|
|
66
|
+
- **Ordering → Fulfillment**: Ordering emits `OrderPlaced` events; Fulfillment consumes them to start picking
|
|
67
|
+
- **Fulfillment → Billing**: Fulfillment emits `ShipmentDispatched` events; Billing consumes them to generate invoices
|
|
68
|
+
- **Ordering ↔ Billing**: Shared types for `CustomerId` and `Money`
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
The skill infers which structure applies:
|
|
72
|
+
|
|
73
|
+
- If `CONTEXT-MAP.md` exists, read it to find contexts
|
|
74
|
+
- If only a root `CONTEXT.md` exists, single context
|
|
75
|
+
- If neither exists, create a root `CONTEXT.md` lazily when the first term is resolved
|
|
76
|
+
|
|
77
|
+
When multiple contexts exist, infer which one the current topic relates to. If unclear, ask.
|