ostacky 0.0.1 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +38 -26
- package/assets/agents/ostacky.md +65 -594
- package/assets/commands/install-stack.md +53 -19
- package/assets/commands/opsx-sync.md +25 -0
- package/assets/skills/brainstorming/SKILL.md +164 -0
- package/assets/skills/brainstorming/SKILL.md.placeholder +36 -0
- package/assets/skills/dispatching-parallel-agents/SKILL.md +182 -0
- package/assets/skills/dispatching-parallel-agents/SKILL.md.placeholder +36 -0
- package/assets/skills/openspec-apply-change/SKILL.md +156 -0
- package/assets/skills/openspec-apply-change/SKILL.md.placeholder +36 -0
- package/assets/skills/openspec-archive-change/SKILL.md +114 -0
- package/assets/skills/openspec-archive-change/SKILL.md.placeholder +36 -0
- package/assets/skills/openspec-explore/SKILL.md +288 -0
- package/assets/skills/openspec-explore/SKILL.md.placeholder +36 -0
- package/assets/skills/openspec-propose/SKILL.md +110 -0
- package/assets/skills/openspec-propose/SKILL.md.placeholder +36 -0
- package/assets/skills/review/SKILL.md +214 -0
- package/assets/skills/review/SKILL.md.placeholder +36 -0
- package/assets/skills/subagent-driven-development/SKILL.md +279 -0
- package/assets/skills/subagent-driven-development/SKILL.md.placeholder +36 -0
- package/assets/skills/tdd/SKILL.md +371 -0
- package/assets/skills/tdd/SKILL.md.placeholder +36 -0
- package/assets/skills/writing-plans/SKILL.md +152 -0
- package/assets/skills/writing-plans/SKILL.md.placeholder +36 -0
- package/dist/cli.js +389 -47
- package/manifest.json +101 -22
- package/package.json +39 -38
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: subagent-driven-development
|
|
3
|
+
description: Execute an implementation plan by delegating to specialized subagents
|
|
4
|
+
source: github.com/obra/superpowers
|
|
5
|
+
ref: main
|
|
6
|
+
status: placeholder
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# subagent-driven-development (placeholder)
|
|
10
|
+
|
|
11
|
+
**Status:** placeholder. Real content must be fetched from upstream via `ostacky sync` (maintainer command).
|
|
12
|
+
|
|
13
|
+
**Source:** github.com/obra/superpowers @ `ref: main`
|
|
14
|
+
**Original path in upstream:** `skills/subagent-driven-development/SKILL.md` (or equivalent — adjust per repo)
|
|
15
|
+
|
|
16
|
+
## What this skill does
|
|
17
|
+
|
|
18
|
+
This file is a placeholder so the bundled installer can copy a complete directory
|
|
19
|
+
structure into `.opencode/skills/subagent-driven-development/`. The CLI hashes the directory tree and
|
|
20
|
+
records the hash in the lockfile. Replacing this placeholder with the real
|
|
21
|
+
upstream content is a maintainer task, not an end-user task.
|
|
22
|
+
|
|
23
|
+
## For end users
|
|
24
|
+
|
|
25
|
+
If you ran `ostacky install` and see this file in your `.opencode/skills/subagent-driven-development/`,
|
|
26
|
+
your installation is working as designed. The curated set is intentionally small.
|
|
27
|
+
To get the real skill content, ask the Ostacky maintainer to refresh the bundle.
|
|
28
|
+
|
|
29
|
+
## For maintainers
|
|
30
|
+
|
|
31
|
+
To populate this placeholder with the real upstream content:
|
|
32
|
+
|
|
33
|
+
1. `git clone --depth=1 https://github.com/github.com/obra/superpowers.git`
|
|
34
|
+
2. Copy `skills/subagent-driven-development/SKILL.md` (and `scripts/`, `references/` if present) to this directory
|
|
35
|
+
3. Update `manifest.json` with the computed tree hash for this skill
|
|
36
|
+
4. Bump version, `npm publish`
|
|
@@ -0,0 +1,371 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: test-driven-development
|
|
3
|
+
description: Use when implementing any feature or bugfix, before writing implementation code
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Test-Driven Development (TDD)
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
Write the test first. Watch it fail. Write minimal code to pass.
|
|
11
|
+
|
|
12
|
+
**Core principle:** If you didn't watch the test fail, you don't know if it tests the right thing.
|
|
13
|
+
|
|
14
|
+
**Violating the letter of the rules is violating the spirit of the rules.**
|
|
15
|
+
|
|
16
|
+
## When to Use
|
|
17
|
+
|
|
18
|
+
**Always:**
|
|
19
|
+
- New features
|
|
20
|
+
- Bug fixes
|
|
21
|
+
- Refactoring
|
|
22
|
+
- Behavior changes
|
|
23
|
+
|
|
24
|
+
**Exceptions (ask your human partner):**
|
|
25
|
+
- Throwaway prototypes
|
|
26
|
+
- Generated code
|
|
27
|
+
- Configuration files
|
|
28
|
+
|
|
29
|
+
Thinking "skip TDD just this once"? Stop. That's rationalization.
|
|
30
|
+
|
|
31
|
+
## The Iron Law
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
NO PRODUCTION CODE WITHOUT A FAILING TEST FIRST
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Write code before the test? Delete it. Start over.
|
|
38
|
+
|
|
39
|
+
**No exceptions:**
|
|
40
|
+
- Don't keep it as "reference"
|
|
41
|
+
- Don't "adapt" it while writing tests
|
|
42
|
+
- Don't look at it
|
|
43
|
+
- Delete means delete
|
|
44
|
+
|
|
45
|
+
Implement fresh from tests. Period.
|
|
46
|
+
|
|
47
|
+
## Red-Green-Refactor
|
|
48
|
+
|
|
49
|
+
```dot
|
|
50
|
+
digraph tdd_cycle {
|
|
51
|
+
rankdir=LR;
|
|
52
|
+
red [label="RED\nWrite failing test", shape=box, style=filled, fillcolor="#ffcccc"];
|
|
53
|
+
verify_red [label="Verify fails\ncorrectly", shape=diamond];
|
|
54
|
+
green [label="GREEN\nMinimal code", shape=box, style=filled, fillcolor="#ccffcc"];
|
|
55
|
+
verify_green [label="Verify passes\nAll green", shape=diamond];
|
|
56
|
+
refactor [label="REFACTOR\nClean up", shape=box, style=filled, fillcolor="#ccccff"];
|
|
57
|
+
next [label="Next", shape=ellipse];
|
|
58
|
+
|
|
59
|
+
red -> verify_red;
|
|
60
|
+
verify_red -> green [label="yes"];
|
|
61
|
+
verify_red -> red [label="wrong\nfailure"];
|
|
62
|
+
green -> verify_green;
|
|
63
|
+
verify_green -> refactor [label="yes"];
|
|
64
|
+
verify_green -> green [label="no"];
|
|
65
|
+
refactor -> verify_green [label="stay\ngreen"];
|
|
66
|
+
verify_green -> next;
|
|
67
|
+
next -> red;
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### RED - Write Failing Test
|
|
72
|
+
|
|
73
|
+
Write one minimal test showing what should happen.
|
|
74
|
+
|
|
75
|
+
<Good>
|
|
76
|
+
```typescript
|
|
77
|
+
test('retries failed operations 3 times', async () => {
|
|
78
|
+
let attempts = 0;
|
|
79
|
+
const operation = () => {
|
|
80
|
+
attempts++;
|
|
81
|
+
if (attempts < 3) throw new Error('fail');
|
|
82
|
+
return 'success';
|
|
83
|
+
};
|
|
84
|
+
|
|
85
|
+
const result = await retryOperation(operation);
|
|
86
|
+
|
|
87
|
+
expect(result).toBe('success');
|
|
88
|
+
expect(attempts).toBe(3);
|
|
89
|
+
});
|
|
90
|
+
```
|
|
91
|
+
Clear name, tests real behavior, one thing
|
|
92
|
+
</Good>
|
|
93
|
+
|
|
94
|
+
<Bad>
|
|
95
|
+
```typescript
|
|
96
|
+
test('retry works', async () => {
|
|
97
|
+
const mock = jest.fn()
|
|
98
|
+
.mockRejectedValueOnce(new Error())
|
|
99
|
+
.mockRejectedValueOnce(new Error())
|
|
100
|
+
.mockResolvedValueOnce('success');
|
|
101
|
+
await retryOperation(mock);
|
|
102
|
+
expect(mock).toHaveBeenCalledTimes(3);
|
|
103
|
+
});
|
|
104
|
+
```
|
|
105
|
+
Vague name, tests mock not code
|
|
106
|
+
</Bad>
|
|
107
|
+
|
|
108
|
+
**Requirements:**
|
|
109
|
+
- One behavior
|
|
110
|
+
- Clear name
|
|
111
|
+
- Real code (no mocks unless unavoidable)
|
|
112
|
+
|
|
113
|
+
### Verify RED - Watch It Fail
|
|
114
|
+
|
|
115
|
+
**MANDATORY. Never skip.**
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
npm test path/to/test.test.ts
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Confirm:
|
|
122
|
+
- Test fails (not errors)
|
|
123
|
+
- Failure message is expected
|
|
124
|
+
- Fails because feature missing (not typos)
|
|
125
|
+
|
|
126
|
+
**Test passes?** You're testing existing behavior. Fix test.
|
|
127
|
+
|
|
128
|
+
**Test errors?** Fix error, re-run until it fails correctly.
|
|
129
|
+
|
|
130
|
+
### GREEN - Minimal Code
|
|
131
|
+
|
|
132
|
+
Write simplest code to pass the test.
|
|
133
|
+
|
|
134
|
+
<Good>
|
|
135
|
+
```typescript
|
|
136
|
+
async function retryOperation<T>(fn: () => Promise<T>): Promise<T> {
|
|
137
|
+
for (let i = 0; i < 3; i++) {
|
|
138
|
+
try {
|
|
139
|
+
return await fn();
|
|
140
|
+
} catch (e) {
|
|
141
|
+
if (i === 2) throw e;
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
throw new Error('unreachable');
|
|
145
|
+
}
|
|
146
|
+
```
|
|
147
|
+
Just enough to pass
|
|
148
|
+
</Good>
|
|
149
|
+
|
|
150
|
+
<Bad>
|
|
151
|
+
```typescript
|
|
152
|
+
async function retryOperation<T>(
|
|
153
|
+
fn: () => Promise<T>,
|
|
154
|
+
options?: {
|
|
155
|
+
maxRetries?: number;
|
|
156
|
+
backoff?: 'linear' | 'exponential';
|
|
157
|
+
onRetry?: (attempt: number) => void;
|
|
158
|
+
}
|
|
159
|
+
): Promise<T> {
|
|
160
|
+
// YAGNI
|
|
161
|
+
}
|
|
162
|
+
```
|
|
163
|
+
Over-engineered
|
|
164
|
+
</Bad>
|
|
165
|
+
|
|
166
|
+
Don't add features, refactor other code, or "improve" beyond the test.
|
|
167
|
+
|
|
168
|
+
### Verify GREEN - Watch It Pass
|
|
169
|
+
|
|
170
|
+
**MANDATORY.**
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
npm test path/to/test.test.ts
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
Confirm:
|
|
177
|
+
- Test passes
|
|
178
|
+
- Other tests still pass
|
|
179
|
+
- Output pristine (no errors, warnings)
|
|
180
|
+
|
|
181
|
+
**Test fails?** Fix code, not test.
|
|
182
|
+
|
|
183
|
+
**Other tests fail?** Fix now.
|
|
184
|
+
|
|
185
|
+
### REFACTOR - Clean Up
|
|
186
|
+
|
|
187
|
+
After green only:
|
|
188
|
+
- Remove duplication
|
|
189
|
+
- Improve names
|
|
190
|
+
- Extract helpers
|
|
191
|
+
|
|
192
|
+
Keep tests green. Don't add behavior.
|
|
193
|
+
|
|
194
|
+
### Repeat
|
|
195
|
+
|
|
196
|
+
Next failing test for next feature.
|
|
197
|
+
|
|
198
|
+
## Good Tests
|
|
199
|
+
|
|
200
|
+
| Quality | Good | Bad |
|
|
201
|
+
|---------|------|-----|
|
|
202
|
+
| **Minimal** | One thing. "and" in name? Split it. | `test('validates email and domain and whitespace')` |
|
|
203
|
+
| **Clear** | Name describes behavior | `test('test1')` |
|
|
204
|
+
| **Shows intent** | Demonstrates desired API | Obscures what code should do |
|
|
205
|
+
|
|
206
|
+
## Why Order Matters
|
|
207
|
+
|
|
208
|
+
**"I'll write tests after to verify it works"**
|
|
209
|
+
|
|
210
|
+
Tests written after code pass immediately. Passing immediately proves nothing:
|
|
211
|
+
- Might test wrong thing
|
|
212
|
+
- Might test implementation, not behavior
|
|
213
|
+
- Might miss edge cases you forgot
|
|
214
|
+
- You never saw it catch the bug
|
|
215
|
+
|
|
216
|
+
Test-first forces you to see the test fail, proving it actually tests something.
|
|
217
|
+
|
|
218
|
+
**"I already manually tested all the edge cases"**
|
|
219
|
+
|
|
220
|
+
Manual testing is ad-hoc. You think you tested everything but:
|
|
221
|
+
- No record of what you tested
|
|
222
|
+
- Can't re-run when code changes
|
|
223
|
+
- Easy to forget cases under pressure
|
|
224
|
+
- "It worked when I tried it" ≠ comprehensive
|
|
225
|
+
|
|
226
|
+
Automated tests are systematic. They run the same way every time.
|
|
227
|
+
|
|
228
|
+
**"Deleting X hours of work is wasteful"**
|
|
229
|
+
|
|
230
|
+
Sunk cost fallacy. The time is already gone. Your choice now:
|
|
231
|
+
- Delete and rewrite with TDD (X more hours, high confidence)
|
|
232
|
+
- Keep it and add tests after (30 min, low confidence, likely bugs)
|
|
233
|
+
|
|
234
|
+
The "waste" is keeping code you can't trust. Working code without real tests is technical debt.
|
|
235
|
+
|
|
236
|
+
**"TDD is dogmatic, being pragmatic means adapting"**
|
|
237
|
+
|
|
238
|
+
TDD IS pragmatic:
|
|
239
|
+
- Finds bugs before commit (faster than debugging after)
|
|
240
|
+
- Prevents regressions (tests catch breaks immediately)
|
|
241
|
+
- Documents behavior (tests show how to use code)
|
|
242
|
+
- Enables refactoring (change freely, tests catch breaks)
|
|
243
|
+
|
|
244
|
+
"Pragmatic" shortcuts = debugging in production = slower.
|
|
245
|
+
|
|
246
|
+
**"Tests after achieve the same goals - it's spirit not ritual"**
|
|
247
|
+
|
|
248
|
+
No. Tests-after answer "What does this do?" Tests-first answer "What should this do?"
|
|
249
|
+
|
|
250
|
+
Tests-after are biased by your implementation. You test what you built, not what's required. You verify remembered edge cases, not discovered ones.
|
|
251
|
+
|
|
252
|
+
Tests-first force edge case discovery before implementing. Tests-after verify you remembered everything (you didn't).
|
|
253
|
+
|
|
254
|
+
30 minutes of tests after ≠ TDD. You get coverage, lose proof tests work.
|
|
255
|
+
|
|
256
|
+
## Common Rationalizations
|
|
257
|
+
|
|
258
|
+
| Excuse | Reality |
|
|
259
|
+
|--------|---------|
|
|
260
|
+
| "Too simple to test" | Simple code breaks. Test takes 30 seconds. |
|
|
261
|
+
| "I'll test after" | Tests passing immediately prove nothing. |
|
|
262
|
+
| "Tests after achieve same goals" | Tests-after = "what does this do?" Tests-first = "what should this do?" |
|
|
263
|
+
| "Already manually tested" | Ad-hoc ≠ systematic. No record, can't re-run. |
|
|
264
|
+
| "Deleting X hours is wasteful" | Sunk cost fallacy. Keeping unverified code is technical debt. |
|
|
265
|
+
| "Keep as reference, write tests first" | You'll adapt it. That's testing after. Delete means delete. |
|
|
266
|
+
| "Need to explore first" | Fine. Throw away exploration, start with TDD. |
|
|
267
|
+
| "Test hard = design unclear" | Listen to test. Hard to test = hard to use. |
|
|
268
|
+
| "TDD will slow me down" | TDD faster than debugging. Pragmatic = test-first. |
|
|
269
|
+
| "Manual test faster" | Manual doesn't prove edge cases. You'll re-test every change. |
|
|
270
|
+
| "Existing code has no tests" | You're improving it. Add tests for existing code. |
|
|
271
|
+
|
|
272
|
+
## Red Flags - STOP and Start Over
|
|
273
|
+
|
|
274
|
+
- Code before test
|
|
275
|
+
- Test after implementation
|
|
276
|
+
- Test passes immediately
|
|
277
|
+
- Can't explain why test failed
|
|
278
|
+
- Tests added "later"
|
|
279
|
+
- Rationalizing "just this once"
|
|
280
|
+
- "I already manually tested it"
|
|
281
|
+
- "Tests after achieve the same purpose"
|
|
282
|
+
- "It's about spirit not ritual"
|
|
283
|
+
- "Keep as reference" or "adapt existing code"
|
|
284
|
+
- "Already spent X hours, deleting is wasteful"
|
|
285
|
+
- "TDD is dogmatic, I'm being pragmatic"
|
|
286
|
+
- "This is different because..."
|
|
287
|
+
|
|
288
|
+
**All of these mean: Delete code. Start over with TDD.**
|
|
289
|
+
|
|
290
|
+
## Example: Bug Fix
|
|
291
|
+
|
|
292
|
+
**Bug:** Empty email accepted
|
|
293
|
+
|
|
294
|
+
**RED**
|
|
295
|
+
```typescript
|
|
296
|
+
test('rejects empty email', async () => {
|
|
297
|
+
const result = await submitForm({ email: '' });
|
|
298
|
+
expect(result.error).toBe('Email required');
|
|
299
|
+
});
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
**Verify RED**
|
|
303
|
+
```bash
|
|
304
|
+
$ npm test
|
|
305
|
+
FAIL: expected 'Email required', got undefined
|
|
306
|
+
```
|
|
307
|
+
|
|
308
|
+
**GREEN**
|
|
309
|
+
```typescript
|
|
310
|
+
function submitForm(data: FormData) {
|
|
311
|
+
if (!data.email?.trim()) {
|
|
312
|
+
return { error: 'Email required' };
|
|
313
|
+
}
|
|
314
|
+
// ...
|
|
315
|
+
}
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
**Verify GREEN**
|
|
319
|
+
```bash
|
|
320
|
+
$ npm test
|
|
321
|
+
PASS
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
**REFACTOR**
|
|
325
|
+
Extract validation for multiple fields if needed.
|
|
326
|
+
|
|
327
|
+
## Verification Checklist
|
|
328
|
+
|
|
329
|
+
Before marking work complete:
|
|
330
|
+
|
|
331
|
+
- [ ] Every new function/method has a test
|
|
332
|
+
- [ ] Watched each test fail before implementing
|
|
333
|
+
- [ ] Each test failed for expected reason (feature missing, not typo)
|
|
334
|
+
- [ ] Wrote minimal code to pass each test
|
|
335
|
+
- [ ] All tests pass
|
|
336
|
+
- [ ] Output pristine (no errors, warnings)
|
|
337
|
+
- [ ] Tests use real code (mocks only if unavoidable)
|
|
338
|
+
- [ ] Edge cases and errors covered
|
|
339
|
+
|
|
340
|
+
Can't check all boxes? You skipped TDD. Start over.
|
|
341
|
+
|
|
342
|
+
## When Stuck
|
|
343
|
+
|
|
344
|
+
| Problem | Solution |
|
|
345
|
+
|---------|----------|
|
|
346
|
+
| Don't know how to test | Write wished-for API. Write assertion first. Ask your human partner. |
|
|
347
|
+
| Test too complicated | Design too complicated. Simplify interface. |
|
|
348
|
+
| Must mock everything | Code too coupled. Use dependency injection. |
|
|
349
|
+
| Test setup huge | Extract helpers. Still complex? Simplify design. |
|
|
350
|
+
|
|
351
|
+
## Debugging Integration
|
|
352
|
+
|
|
353
|
+
Bug found? Write failing test reproducing it. Follow TDD cycle. Test proves fix and prevents regression.
|
|
354
|
+
|
|
355
|
+
Never fix bugs without a test.
|
|
356
|
+
|
|
357
|
+
## Testing Anti-Patterns
|
|
358
|
+
|
|
359
|
+
When adding mocks or test utilities, read @testing-anti-patterns.md to avoid common pitfalls:
|
|
360
|
+
- Testing mock behavior instead of real behavior
|
|
361
|
+
- Adding test-only methods to production classes
|
|
362
|
+
- Mocking without understanding dependencies
|
|
363
|
+
|
|
364
|
+
## Final Rule
|
|
365
|
+
|
|
366
|
+
```
|
|
367
|
+
Production code → test exists and failed first
|
|
368
|
+
Otherwise → not TDD
|
|
369
|
+
```
|
|
370
|
+
|
|
371
|
+
No exceptions without your human partner's permission.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: tdd
|
|
3
|
+
description: Test-driven development: failing test, minimal implementation, refactor
|
|
4
|
+
source: github.com/obra/superpowers
|
|
5
|
+
ref: main
|
|
6
|
+
status: placeholder
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# tdd (placeholder)
|
|
10
|
+
|
|
11
|
+
**Status:** placeholder. Real content must be fetched from upstream via `ostacky sync` (maintainer command).
|
|
12
|
+
|
|
13
|
+
**Source:** github.com/obra/superpowers @ `ref: main`
|
|
14
|
+
**Original path in upstream:** `skills/tdd/SKILL.md` (or equivalent — adjust per repo)
|
|
15
|
+
|
|
16
|
+
## What this skill does
|
|
17
|
+
|
|
18
|
+
This file is a placeholder so the bundled installer can copy a complete directory
|
|
19
|
+
structure into `.opencode/skills/tdd/`. The CLI hashes the directory tree and
|
|
20
|
+
records the hash in the lockfile. Replacing this placeholder with the real
|
|
21
|
+
upstream content is a maintainer task, not an end-user task.
|
|
22
|
+
|
|
23
|
+
## For end users
|
|
24
|
+
|
|
25
|
+
If you ran `ostacky install` and see this file in your `.opencode/skills/tdd/`,
|
|
26
|
+
your installation is working as designed. The curated set is intentionally small.
|
|
27
|
+
To get the real skill content, ask the Ostacky maintainer to refresh the bundle.
|
|
28
|
+
|
|
29
|
+
## For maintainers
|
|
30
|
+
|
|
31
|
+
To populate this placeholder with the real upstream content:
|
|
32
|
+
|
|
33
|
+
1. `git clone --depth=1 https://github.com/github.com/obra/superpowers.git`
|
|
34
|
+
2. Copy `skills/tdd/SKILL.md` (and `scripts/`, `references/` if present) to this directory
|
|
35
|
+
3. Update `manifest.json` with the computed tree hash for this skill
|
|
36
|
+
4. Bump version, `npm publish`
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: writing-plans
|
|
3
|
+
description: Use when you have a spec or requirements for a multi-step task, before touching code
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Writing Plans
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
Write comprehensive implementation plans assuming the engineer has zero context for our codebase and questionable taste. Document everything they need to know: which files to touch for each task, code, testing, docs they might need to check, how to test it. Give them the whole plan as bite-sized tasks. DRY. YAGNI. TDD. Frequent commits.
|
|
11
|
+
|
|
12
|
+
Assume they are a skilled developer, but know almost nothing about our toolset or problem domain. Assume they don't know good test design very well.
|
|
13
|
+
|
|
14
|
+
**Announce at start:** "I'm using the writing-plans skill to create the implementation plan."
|
|
15
|
+
|
|
16
|
+
**Context:** If working in an isolated worktree, it should have been created via the `superpowers:using-git-worktrees` skill at execution time.
|
|
17
|
+
|
|
18
|
+
**Save plans to:** `docs/superpowers/plans/YYYY-MM-DD-<feature-name>.md`
|
|
19
|
+
- (User preferences for plan location override this default)
|
|
20
|
+
|
|
21
|
+
## Scope Check
|
|
22
|
+
|
|
23
|
+
If the spec covers multiple independent subsystems, it should have been broken into sub-project specs during brainstorming. If it wasn't, suggest breaking this into separate plans — one per subsystem. Each plan should produce working, testable software on its own.
|
|
24
|
+
|
|
25
|
+
## File Structure
|
|
26
|
+
|
|
27
|
+
Before defining tasks, map out which files will be created or modified and what each one is responsible for. This is where decomposition decisions get locked in.
|
|
28
|
+
|
|
29
|
+
- Design units with clear boundaries and well-defined interfaces. Each file should have one clear responsibility.
|
|
30
|
+
- You reason best about code you can hold in context at once, and your edits are more reliable when files are focused. Prefer smaller, focused files over large ones that do too much.
|
|
31
|
+
- Files that change together should live together. Split by responsibility, not by technical layer.
|
|
32
|
+
- In existing codebases, follow established patterns. If the codebase uses large files, don't unilaterally restructure - but if a file you're modifying has grown unwieldy, including a split in the plan is reasonable.
|
|
33
|
+
|
|
34
|
+
This structure informs the task decomposition. Each task should produce self-contained changes that make sense independently.
|
|
35
|
+
|
|
36
|
+
## Bite-Sized Task Granularity
|
|
37
|
+
|
|
38
|
+
**Each step is one action (2-5 minutes):**
|
|
39
|
+
- "Write the failing test" - step
|
|
40
|
+
- "Run it to make sure it fails" - step
|
|
41
|
+
- "Implement the minimal code to make the test pass" - step
|
|
42
|
+
- "Run the tests and make sure they pass" - step
|
|
43
|
+
- "Commit" - step
|
|
44
|
+
|
|
45
|
+
## Plan Document Header
|
|
46
|
+
|
|
47
|
+
**Every plan MUST start with this header:**
|
|
48
|
+
|
|
49
|
+
```markdown
|
|
50
|
+
# [Feature Name] Implementation Plan
|
|
51
|
+
|
|
52
|
+
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
|
53
|
+
|
|
54
|
+
**Goal:** [One sentence describing what this builds]
|
|
55
|
+
|
|
56
|
+
**Architecture:** [2-3 sentences about approach]
|
|
57
|
+
|
|
58
|
+
**Tech Stack:** [Key technologies/libraries]
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Task Structure
|
|
64
|
+
|
|
65
|
+
````markdown
|
|
66
|
+
### Task N: [Component Name]
|
|
67
|
+
|
|
68
|
+
**Files:**
|
|
69
|
+
- Create: `exact/path/to/file.py`
|
|
70
|
+
- Modify: `exact/path/to/existing.py:123-145`
|
|
71
|
+
- Test: `tests/exact/path/to/test.py`
|
|
72
|
+
|
|
73
|
+
- [ ] **Step 1: Write the failing test**
|
|
74
|
+
|
|
75
|
+
```python
|
|
76
|
+
def test_specific_behavior():
|
|
77
|
+
result = function(input)
|
|
78
|
+
assert result == expected
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
- [ ] **Step 2: Run test to verify it fails**
|
|
82
|
+
|
|
83
|
+
Run: `pytest tests/path/test.py::test_name -v`
|
|
84
|
+
Expected: FAIL with "function not defined"
|
|
85
|
+
|
|
86
|
+
- [ ] **Step 3: Write minimal implementation**
|
|
87
|
+
|
|
88
|
+
```python
|
|
89
|
+
def function(input):
|
|
90
|
+
return expected
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
- [ ] **Step 4: Run test to verify it passes**
|
|
94
|
+
|
|
95
|
+
Run: `pytest tests/path/test.py::test_name -v`
|
|
96
|
+
Expected: PASS
|
|
97
|
+
|
|
98
|
+
- [ ] **Step 5: Commit**
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
git add tests/path/test.py src/path/file.py
|
|
102
|
+
git commit -m "feat: add specific feature"
|
|
103
|
+
```
|
|
104
|
+
````
|
|
105
|
+
|
|
106
|
+
## No Placeholders
|
|
107
|
+
|
|
108
|
+
Every step must contain the actual content an engineer needs. These are **plan failures** — never write them:
|
|
109
|
+
- "TBD", "TODO", "implement later", "fill in details"
|
|
110
|
+
- "Add appropriate error handling" / "add validation" / "handle edge cases"
|
|
111
|
+
- "Write tests for the above" (without actual test code)
|
|
112
|
+
- "Similar to Task N" (repeat the code — the engineer may be reading tasks out of order)
|
|
113
|
+
- Steps that describe what to do without showing how (code blocks required for code steps)
|
|
114
|
+
- References to types, functions, or methods not defined in any task
|
|
115
|
+
|
|
116
|
+
## Remember
|
|
117
|
+
- Exact file paths always
|
|
118
|
+
- Complete code in every step — if a step changes code, show the code
|
|
119
|
+
- Exact commands with expected output
|
|
120
|
+
- DRY, YAGNI, TDD, frequent commits
|
|
121
|
+
|
|
122
|
+
## Self-Review
|
|
123
|
+
|
|
124
|
+
After writing the complete plan, look at the spec with fresh eyes and check the plan against it. This is a checklist you run yourself — not a subagent dispatch.
|
|
125
|
+
|
|
126
|
+
**1. Spec coverage:** Skim each section/requirement in the spec. Can you point to a task that implements it? List any gaps.
|
|
127
|
+
|
|
128
|
+
**2. Placeholder scan:** Search your plan for red flags — any of the patterns from the "No Placeholders" section above. Fix them.
|
|
129
|
+
|
|
130
|
+
**3. Type consistency:** Do the types, method signatures, and property names you used in later tasks match what you defined in earlier tasks? A function called `clearLayers()` in Task 3 but `clearFullLayers()` in Task 7 is a bug.
|
|
131
|
+
|
|
132
|
+
If you find issues, fix them inline. No need to re-review — just fix and move on. If you find a spec requirement with no task, add the task.
|
|
133
|
+
|
|
134
|
+
## Execution Handoff
|
|
135
|
+
|
|
136
|
+
After saving the plan, offer execution choice:
|
|
137
|
+
|
|
138
|
+
**"Plan complete and saved to `docs/superpowers/plans/<filename>.md`. Two execution options:**
|
|
139
|
+
|
|
140
|
+
**1. Subagent-Driven (recommended)** - I dispatch a fresh subagent per task, review between tasks, fast iteration
|
|
141
|
+
|
|
142
|
+
**2. Inline Execution** - Execute tasks in this session using executing-plans, batch execution with checkpoints
|
|
143
|
+
|
|
144
|
+
**Which approach?"**
|
|
145
|
+
|
|
146
|
+
**If Subagent-Driven chosen:**
|
|
147
|
+
- **REQUIRED SUB-SKILL:** Use superpowers:subagent-driven-development
|
|
148
|
+
- Fresh subagent per task + two-stage review
|
|
149
|
+
|
|
150
|
+
**If Inline Execution chosen:**
|
|
151
|
+
- **REQUIRED SUB-SKILL:** Use superpowers:executing-plans
|
|
152
|
+
- Batch execution with checkpoints for review
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: writing-plans
|
|
3
|
+
description: Break a spec or requirements into a multi-step implementation plan
|
|
4
|
+
source: github.com/obra/superpowers
|
|
5
|
+
ref: main
|
|
6
|
+
status: placeholder
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# writing-plans (placeholder)
|
|
10
|
+
|
|
11
|
+
**Status:** placeholder. Real content must be fetched from upstream via `ostacky sync` (maintainer command).
|
|
12
|
+
|
|
13
|
+
**Source:** github.com/obra/superpowers @ `ref: main`
|
|
14
|
+
**Original path in upstream:** `skills/writing-plans/SKILL.md` (or equivalent — adjust per repo)
|
|
15
|
+
|
|
16
|
+
## What this skill does
|
|
17
|
+
|
|
18
|
+
This file is a placeholder so the bundled installer can copy a complete directory
|
|
19
|
+
structure into `.opencode/skills/writing-plans/`. The CLI hashes the directory tree and
|
|
20
|
+
records the hash in the lockfile. Replacing this placeholder with the real
|
|
21
|
+
upstream content is a maintainer task, not an end-user task.
|
|
22
|
+
|
|
23
|
+
## For end users
|
|
24
|
+
|
|
25
|
+
If you ran `ostacky install` and see this file in your `.opencode/skills/writing-plans/`,
|
|
26
|
+
your installation is working as designed. The curated set is intentionally small.
|
|
27
|
+
To get the real skill content, ask the Ostacky maintainer to refresh the bundle.
|
|
28
|
+
|
|
29
|
+
## For maintainers
|
|
30
|
+
|
|
31
|
+
To populate this placeholder with the real upstream content:
|
|
32
|
+
|
|
33
|
+
1. `git clone --depth=1 https://github.com/github.com/obra/superpowers.git`
|
|
34
|
+
2. Copy `skills/writing-plans/SKILL.md` (and `scripts/`, `references/` if present) to this directory
|
|
35
|
+
3. Update `manifest.json` with the computed tree hash for this skill
|
|
36
|
+
4. Bump version, `npm publish`
|