@selesai/code 0.13.30-beta.0 → 0.13.31
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/CHANGELOG.md +7 -1
- package/README.md +8 -2
- package/dist/core/settings-manager-auto-handoff.test.js +11 -0
- package/dist/core/settings-manager.d.ts +10 -0
- package/dist/core/settings-manager.js +6 -0
- package/dist/defaults/settings.json +5 -0
- package/dist/extensions/capability-gateway/index.ts +17 -4
- package/dist/extensions/capability-gateway/integration.test.ts +26 -3
- package/dist/extensions/capability-gateway/routing.test.ts +11 -5
- package/dist/extensions/capability-gateway/routing.ts +6 -6
- package/dist/modes/interactive/components/settings-selector.d.ts +2 -0
- package/dist/modes/interactive/components/settings-selector.js +12 -0
- package/dist/modes/interactive/interactive-mode.js +18 -0
- package/dist/skills/code-review-and-quality/SKILL.md +396 -0
- package/dist/skills/code-simplification/SKILL.md +331 -0
- package/dist/skills/incremental-implementation/SKILL.md +249 -0
- package/dist/skills/planning-and-task-breakdown/SKILL.md +257 -0
- package/dist/skills/references/agent-skills-LICENSE +21 -0
- package/dist/skills/references/definition-of-done.md +67 -0
- package/dist/skills/references/performance-checklist.md +236 -0
- package/dist/skills/references/security-checklist.md +248 -0
- package/docs/settings.md +8 -7
- package/package.json +3 -3
|
@@ -0,0 +1,331 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: code-simplification
|
|
3
|
+
description: Simplifies code for clarity. Use when refactoring code for clarity without changing behavior. Use when code works but is harder to read, maintain, or extend than it should be. Use when reviewing code that has accumulated unnecessary complexity.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Code Simplification
|
|
7
|
+
|
|
8
|
+
> Inspired by the [Claude Code Simplifier plugin](https://github.com/anthropics/claude-plugins-official/blob/main/plugins/code-simplifier/agents/code-simplifier.md). Adapted here as a model-agnostic, process-driven skill for any AI coding agent.
|
|
9
|
+
|
|
10
|
+
## Overview
|
|
11
|
+
|
|
12
|
+
Simplify code by reducing complexity while preserving exact behavior. The goal is not fewer lines — it's code that is easier to read, understand, modify, and debug. Every simplification must pass a simple test: "Would a new team member understand this faster than the original?"
|
|
13
|
+
|
|
14
|
+
## When to Use
|
|
15
|
+
|
|
16
|
+
- After a feature is working and tests pass, but the implementation feels heavier than it needs to be
|
|
17
|
+
- During code review when readability or complexity issues are flagged
|
|
18
|
+
- When you encounter deeply nested logic, long functions, or unclear names
|
|
19
|
+
- When refactoring code written under time pressure
|
|
20
|
+
- When consolidating related logic scattered across files
|
|
21
|
+
- After merging changes that introduced duplication or inconsistency
|
|
22
|
+
|
|
23
|
+
**When NOT to use:**
|
|
24
|
+
|
|
25
|
+
- Code is already clean and readable — don't simplify for the sake of it
|
|
26
|
+
- You don't understand what the code does yet — comprehend before you simplify
|
|
27
|
+
- The code is performance-critical and the "simpler" version would be measurably slower
|
|
28
|
+
- You're about to rewrite the module entirely — simplifying throwaway code wastes effort
|
|
29
|
+
|
|
30
|
+
## The Five Principles
|
|
31
|
+
|
|
32
|
+
### 1. Preserve Behavior Exactly
|
|
33
|
+
|
|
34
|
+
Don't change what the code does — only how it expresses it. All inputs, outputs, side effects, error behavior, and edge cases must remain identical. If you're not sure a simplification preserves behavior, don't make it.
|
|
35
|
+
|
|
36
|
+
```
|
|
37
|
+
ASK BEFORE EVERY CHANGE:
|
|
38
|
+
→ Does this produce the same output for every input?
|
|
39
|
+
→ Does this maintain the same error behavior?
|
|
40
|
+
→ Does this preserve the same side effects and ordering?
|
|
41
|
+
→ Do all existing tests still pass without modification?
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### 2. Follow Project Conventions
|
|
45
|
+
|
|
46
|
+
Simplification means making code more consistent with the codebase, not imposing external preferences. Before simplifying:
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
1. Read CLAUDE.md / project conventions
|
|
50
|
+
2. Study how neighboring code handles similar patterns
|
|
51
|
+
3. Match the project's style for:
|
|
52
|
+
- Import ordering and module system
|
|
53
|
+
- Function declaration style
|
|
54
|
+
- Naming conventions
|
|
55
|
+
- Error handling patterns
|
|
56
|
+
- Type annotation depth
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Simplification that breaks project consistency is not simplification — it's churn.
|
|
60
|
+
|
|
61
|
+
### 3. Prefer Clarity Over Cleverness
|
|
62
|
+
|
|
63
|
+
Explicit code is better than compact code when the compact version requires a mental pause to parse.
|
|
64
|
+
|
|
65
|
+
```typescript
|
|
66
|
+
// UNCLEAR: Dense ternary chain
|
|
67
|
+
const label = isNew ? 'New' : isUpdated ? 'Updated' : isArchived ? 'Archived' : 'Active';
|
|
68
|
+
|
|
69
|
+
// CLEAR: Readable mapping
|
|
70
|
+
function getStatusLabel(item: Item): string {
|
|
71
|
+
if (item.isNew) return 'New';
|
|
72
|
+
if (item.isUpdated) return 'Updated';
|
|
73
|
+
if (item.isArchived) return 'Archived';
|
|
74
|
+
return 'Active';
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
```typescript
|
|
79
|
+
// UNCLEAR: Chained reduces with inline logic
|
|
80
|
+
const result = items.reduce((acc, item) => ({
|
|
81
|
+
...acc,
|
|
82
|
+
[item.id]: { ...acc[item.id], count: (acc[item.id]?.count ?? 0) + 1 }
|
|
83
|
+
}), {});
|
|
84
|
+
|
|
85
|
+
// CLEAR: Named intermediate step
|
|
86
|
+
const countById = new Map<string, number>();
|
|
87
|
+
for (const item of items) {
|
|
88
|
+
countById.set(item.id, (countById.get(item.id) ?? 0) + 1);
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### 4. Maintain Balance
|
|
93
|
+
|
|
94
|
+
Simplification has a failure mode: over-simplification. Watch for these traps:
|
|
95
|
+
|
|
96
|
+
- **Inlining too aggressively** — removing a helper that gave a concept a name makes the call site harder to read
|
|
97
|
+
- **Combining unrelated logic** — two simple functions merged into one complex function is not simpler
|
|
98
|
+
- **Removing "unnecessary" abstraction** — some abstractions exist for extensibility or testability, not complexity
|
|
99
|
+
- **Optimizing for line count** — fewer lines is not the goal; easier comprehension is
|
|
100
|
+
|
|
101
|
+
### 5. Scope to What Changed
|
|
102
|
+
|
|
103
|
+
Default to simplifying recently modified code. Avoid drive-by refactors of unrelated code unless explicitly asked to broaden scope. Unscoped simplification creates noise in diffs and risks unintended regressions.
|
|
104
|
+
|
|
105
|
+
## The Simplification Process
|
|
106
|
+
|
|
107
|
+
### Step 1: Understand Before Touching (Chesterton's Fence)
|
|
108
|
+
|
|
109
|
+
Before changing or removing anything, understand why it exists. This is Chesterton's Fence: if you see a fence across a road and don't understand why it's there, don't tear it down. First understand the reason, then decide if the reason still applies.
|
|
110
|
+
|
|
111
|
+
```
|
|
112
|
+
BEFORE SIMPLIFYING, ANSWER:
|
|
113
|
+
- What is this code's responsibility?
|
|
114
|
+
- What calls it? What does it call?
|
|
115
|
+
- What are the edge cases and error paths?
|
|
116
|
+
- Are there tests that define the expected behavior?
|
|
117
|
+
- Why might it have been written this way? (Performance? Platform constraint? Historical reason?)
|
|
118
|
+
- Check git blame: what was the original context for this code?
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
If you can't answer these, you're not ready to simplify. Read more context first.
|
|
122
|
+
|
|
123
|
+
### Step 2: Identify Simplification Opportunities
|
|
124
|
+
|
|
125
|
+
Scan for these patterns — each one is a concrete signal, not a vague smell:
|
|
126
|
+
|
|
127
|
+
**Structural complexity:**
|
|
128
|
+
|
|
129
|
+
| Pattern | Signal | Simplification |
|
|
130
|
+
|---------|--------|----------------|
|
|
131
|
+
| Deep nesting (3+ levels) | Hard to follow control flow | Extract conditions into guard clauses or helper functions |
|
|
132
|
+
| Long functions (50+ lines) | Multiple responsibilities | Split into focused functions with descriptive names |
|
|
133
|
+
| Nested ternaries | Requires mental stack to parse | Replace with if/else chains, switch, or lookup objects |
|
|
134
|
+
| Boolean parameter flags | `doThing(true, false, true)` | Replace with options objects or separate functions |
|
|
135
|
+
| Repeated conditionals | Same `if` check in multiple places | Extract to a well-named predicate function |
|
|
136
|
+
|
|
137
|
+
**Naming and readability:**
|
|
138
|
+
|
|
139
|
+
| Pattern | Signal | Simplification |
|
|
140
|
+
|---------|--------|----------------|
|
|
141
|
+
| Generic names | `data`, `result`, `temp`, `val`, `item` | Rename to describe the content: `userProfile`, `validationErrors` |
|
|
142
|
+
| Abbreviated names | `usr`, `cfg`, `btn`, `evt` | Use full words unless the abbreviation is universal (`id`, `url`, `api`) |
|
|
143
|
+
| Misleading names | Function named `get` that also mutates state | Rename to reflect actual behavior |
|
|
144
|
+
| Comments explaining "what" | `// increment counter` above `count++` | Delete the comment — the code is clear enough |
|
|
145
|
+
| Comments explaining "why" | `// Retry because the API is flaky under load` | Keep these — they carry intent the code can't express |
|
|
146
|
+
|
|
147
|
+
**Redundancy:**
|
|
148
|
+
|
|
149
|
+
| Pattern | Signal | Simplification |
|
|
150
|
+
|---------|--------|----------------|
|
|
151
|
+
| Duplicated logic | Same 5+ lines in multiple places | Extract to a shared function |
|
|
152
|
+
| Dead code | Unreachable branches, unused variables, commented-out blocks | Remove (after confirming it's truly dead) |
|
|
153
|
+
| Unnecessary abstractions | Wrapper that adds no value | Inline the wrapper, call the underlying function directly |
|
|
154
|
+
| Over-engineered patterns | Factory-for-a-factory, strategy-with-one-strategy | Replace with the simple direct approach |
|
|
155
|
+
| Redundant type assertions | Casting to a type that's already inferred | Remove the assertion |
|
|
156
|
+
|
|
157
|
+
### Step 3: Apply Changes Incrementally
|
|
158
|
+
|
|
159
|
+
Make one simplification at a time. Run tests after each change. **Submit refactoring changes separately from feature or bug fix changes.** A PR that refactors and adds a feature is two PRs — split them.
|
|
160
|
+
|
|
161
|
+
```
|
|
162
|
+
FOR EACH SIMPLIFICATION:
|
|
163
|
+
1. Make the change
|
|
164
|
+
2. Run the test suite
|
|
165
|
+
3. If tests pass → commit (or continue to next simplification)
|
|
166
|
+
4. If tests fail → revert and reconsider
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
Avoid batching multiple simplifications into a single untested change. If something breaks, you need to know which simplification caused it.
|
|
170
|
+
|
|
171
|
+
**The Rule of 500:** If a refactoring would touch more than 500 lines, invest in automation (codemods, sed scripts, AST transforms) rather than making the changes by hand. Manual edits at that scale are error-prone and exhausting to review.
|
|
172
|
+
|
|
173
|
+
### Step 4: Verify the Result
|
|
174
|
+
|
|
175
|
+
After all simplifications, step back and evaluate the whole:
|
|
176
|
+
|
|
177
|
+
```
|
|
178
|
+
COMPARE BEFORE AND AFTER:
|
|
179
|
+
- Is the simplified version genuinely easier to understand?
|
|
180
|
+
- Did you introduce any new patterns inconsistent with the codebase?
|
|
181
|
+
- Is the diff clean and reviewable?
|
|
182
|
+
- Would a teammate approve this change?
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
If the "simplified" version is harder to understand or review, revert. Not every simplification attempt succeeds.
|
|
186
|
+
|
|
187
|
+
## Language-Specific Guidance
|
|
188
|
+
|
|
189
|
+
### TypeScript / JavaScript
|
|
190
|
+
|
|
191
|
+
```typescript
|
|
192
|
+
// SIMPLIFY: Unnecessary async wrapper
|
|
193
|
+
// Before
|
|
194
|
+
async function getUser(id: string): Promise<User> {
|
|
195
|
+
return await userService.findById(id);
|
|
196
|
+
}
|
|
197
|
+
// After
|
|
198
|
+
function getUser(id: string): Promise<User> {
|
|
199
|
+
return userService.findById(id);
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
// SIMPLIFY: Verbose conditional assignment
|
|
203
|
+
// Before
|
|
204
|
+
let displayName: string;
|
|
205
|
+
if (user.nickname) {
|
|
206
|
+
displayName = user.nickname;
|
|
207
|
+
} else {
|
|
208
|
+
displayName = user.fullName;
|
|
209
|
+
}
|
|
210
|
+
// After
|
|
211
|
+
const displayName = user.nickname || user.fullName;
|
|
212
|
+
|
|
213
|
+
// SIMPLIFY: Manual array building
|
|
214
|
+
// Before
|
|
215
|
+
const activeUsers: User[] = [];
|
|
216
|
+
for (const user of users) {
|
|
217
|
+
if (user.isActive) {
|
|
218
|
+
activeUsers.push(user);
|
|
219
|
+
}
|
|
220
|
+
}
|
|
221
|
+
// After
|
|
222
|
+
const activeUsers = users.filter((user) => user.isActive);
|
|
223
|
+
|
|
224
|
+
// SIMPLIFY: Redundant boolean return
|
|
225
|
+
// Before
|
|
226
|
+
function isValid(input: string): boolean {
|
|
227
|
+
if (input.length > 0 && input.length < 100) {
|
|
228
|
+
return true;
|
|
229
|
+
}
|
|
230
|
+
return false;
|
|
231
|
+
}
|
|
232
|
+
// After
|
|
233
|
+
function isValid(input: string): boolean {
|
|
234
|
+
return input.length > 0 && input.length < 100;
|
|
235
|
+
}
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
### Python
|
|
239
|
+
|
|
240
|
+
```python
|
|
241
|
+
# SIMPLIFY: Verbose dictionary building
|
|
242
|
+
# Before
|
|
243
|
+
result = {}
|
|
244
|
+
for item in items:
|
|
245
|
+
result[item.id] = item.name
|
|
246
|
+
# After
|
|
247
|
+
result = {item.id: item.name for item in items}
|
|
248
|
+
|
|
249
|
+
# SIMPLIFY: Nested conditionals with early return
|
|
250
|
+
# Before
|
|
251
|
+
def process(data):
|
|
252
|
+
if data is not None:
|
|
253
|
+
if data.is_valid():
|
|
254
|
+
if data.has_permission():
|
|
255
|
+
return do_work(data)
|
|
256
|
+
else:
|
|
257
|
+
raise PermissionError("No permission")
|
|
258
|
+
else:
|
|
259
|
+
raise ValueError("Invalid data")
|
|
260
|
+
else:
|
|
261
|
+
raise TypeError("Data is None")
|
|
262
|
+
# After
|
|
263
|
+
def process(data):
|
|
264
|
+
if data is None:
|
|
265
|
+
raise TypeError("Data is None")
|
|
266
|
+
if not data.is_valid():
|
|
267
|
+
raise ValueError("Invalid data")
|
|
268
|
+
if not data.has_permission():
|
|
269
|
+
raise PermissionError("No permission")
|
|
270
|
+
return do_work(data)
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
### React / JSX
|
|
274
|
+
|
|
275
|
+
```tsx
|
|
276
|
+
// SIMPLIFY: Verbose conditional rendering
|
|
277
|
+
// Before
|
|
278
|
+
function UserBadge({ user }: Props) {
|
|
279
|
+
if (user.isAdmin) {
|
|
280
|
+
return <Badge variant="admin">Admin</Badge>;
|
|
281
|
+
} else {
|
|
282
|
+
return <Badge variant="default">User</Badge>;
|
|
283
|
+
}
|
|
284
|
+
}
|
|
285
|
+
// After
|
|
286
|
+
function UserBadge({ user }: Props) {
|
|
287
|
+
const variant = user.isAdmin ? 'admin' : 'default';
|
|
288
|
+
const label = user.isAdmin ? 'Admin' : 'User';
|
|
289
|
+
return <Badge variant={variant}>{label}</Badge>;
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
// SIMPLIFY: Prop drilling through intermediate components
|
|
293
|
+
// Before — consider whether context or composition solves this better.
|
|
294
|
+
// This is a judgment call — flag it, don't auto-refactor.
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
## Common Rationalizations
|
|
298
|
+
|
|
299
|
+
| Rationalization | Reality |
|
|
300
|
+
|---|---|
|
|
301
|
+
| "It's working, no need to touch it" | Working code that's hard to read will be hard to fix when it breaks. Simplifying now saves time on every future change. |
|
|
302
|
+
| "Fewer lines is always simpler" | A 1-line nested ternary is not simpler than a 5-line if/else. Simplicity is about comprehension speed, not line count. |
|
|
303
|
+
| "I'll just quickly simplify this unrelated code too" | Unscoped simplification creates noisy diffs and risks regressions in code you didn't intend to change. Stay focused. |
|
|
304
|
+
| "The types make it self-documenting" | Types document structure, not intent. A well-named function explains *why* better than a type signature explains *what*. |
|
|
305
|
+
| "This abstraction might be useful later" | Don't preserve speculative abstractions. If it's not used now, it's complexity without value. Remove it and re-add when needed. |
|
|
306
|
+
| "The original author must have had a reason" | Maybe. Check git blame — apply Chesterton's Fence. But accumulated complexity often has no reason; it's just the residue of iteration under pressure. |
|
|
307
|
+
| "I'll refactor while adding this feature" | Separate refactoring from feature work. Mixed changes are harder to review, revert, and understand in history. |
|
|
308
|
+
|
|
309
|
+
## Red Flags
|
|
310
|
+
|
|
311
|
+
- Simplification that requires modifying tests to pass (you likely changed behavior)
|
|
312
|
+
- "Simplified" code that is longer and harder to follow than the original
|
|
313
|
+
- Renaming things to match your preferences rather than project conventions
|
|
314
|
+
- Removing error handling because "it makes the code cleaner"
|
|
315
|
+
- Simplifying code you don't fully understand
|
|
316
|
+
- Batching many simplifications into one large, hard-to-review commit
|
|
317
|
+
- Refactoring code outside the scope of the current task without being asked
|
|
318
|
+
|
|
319
|
+
## Verification
|
|
320
|
+
|
|
321
|
+
After completing a simplification pass:
|
|
322
|
+
|
|
323
|
+
- [ ] All existing tests pass without modification
|
|
324
|
+
- [ ] Build succeeds with no new warnings
|
|
325
|
+
- [ ] Linter/formatter passes (no style regressions)
|
|
326
|
+
- [ ] Each simplification is a reviewable, incremental change
|
|
327
|
+
- [ ] The diff is clean — no unrelated changes mixed in
|
|
328
|
+
- [ ] Simplified code follows project conventions (checked against CLAUDE.md or equivalent)
|
|
329
|
+
- [ ] No error handling was removed or weakened
|
|
330
|
+
- [ ] No dead code was left behind (unused imports, unreachable branches)
|
|
331
|
+
- [ ] A teammate or review agent would approve the change as a net improvement
|
|
@@ -0,0 +1,249 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: incremental-implementation
|
|
3
|
+
description: Delivers changes incrementally in thin, verifiable slices. Use when implementing any feature or change that touches more than one file, or when picking up the next task from a plan. Use when rolling a change out behind a feature flag, when you're about to write a large amount of code at once, or when a task feels too big to land in one step.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Incremental Implementation
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
Build in thin vertical slices — implement one piece, test it, verify it, then expand. Avoid implementing an entire feature in one pass. Each increment should leave the system in a working, testable state. This is the execution discipline that makes large features manageable.
|
|
11
|
+
|
|
12
|
+
## When to Use
|
|
13
|
+
|
|
14
|
+
- Implementing any multi-file change
|
|
15
|
+
- Building a new feature from a task breakdown
|
|
16
|
+
- Refactoring existing code
|
|
17
|
+
- Any time you're tempted to write more than ~100 lines before testing
|
|
18
|
+
|
|
19
|
+
**When NOT to use:** Single-file, single-function changes where the scope is already minimal.
|
|
20
|
+
|
|
21
|
+
## The Increment Cycle
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
┌──────────────────────────────────────┐
|
|
25
|
+
│ │
|
|
26
|
+
│ Implement ──→ Test ──→ Verify ──┐ │
|
|
27
|
+
│ ▲ │ │
|
|
28
|
+
│ └───── Commit ◄─────────────┘ │
|
|
29
|
+
│ │ │
|
|
30
|
+
│ ▼ │
|
|
31
|
+
│ Next slice │
|
|
32
|
+
│ │
|
|
33
|
+
└──────────────────────────────────────┘
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
For each slice:
|
|
37
|
+
|
|
38
|
+
1. **Implement** the smallest complete piece of functionality
|
|
39
|
+
2. **Test** — run the test suite (or write a test if none exists)
|
|
40
|
+
3. **Verify** — confirm the slice works as expected (tests pass, build succeeds, manual check)
|
|
41
|
+
4. **Commit** -- save your progress with a descriptive message (see `git-workflow-and-versioning` for atomic commit guidance)
|
|
42
|
+
5. **Move to the next slice** — carry forward, don't restart
|
|
43
|
+
|
|
44
|
+
## Slicing Strategies
|
|
45
|
+
|
|
46
|
+
### Vertical Slices (Preferred)
|
|
47
|
+
|
|
48
|
+
Build one complete path through the stack:
|
|
49
|
+
|
|
50
|
+
```
|
|
51
|
+
Slice 1: Create a task (DB + API + basic UI)
|
|
52
|
+
→ Tests pass, user can create a task via the UI
|
|
53
|
+
|
|
54
|
+
Slice 2: List tasks (query + API + UI)
|
|
55
|
+
→ Tests pass, user can see their tasks
|
|
56
|
+
|
|
57
|
+
Slice 3: Edit a task (update + API + UI)
|
|
58
|
+
→ Tests pass, user can modify tasks
|
|
59
|
+
|
|
60
|
+
Slice 4: Delete a task (delete + API + UI + confirmation)
|
|
61
|
+
→ Tests pass, full CRUD complete
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
Each slice delivers working end-to-end functionality.
|
|
65
|
+
|
|
66
|
+
### Contract-First Slicing
|
|
67
|
+
|
|
68
|
+
When backend and frontend need to develop in parallel:
|
|
69
|
+
|
|
70
|
+
```
|
|
71
|
+
Slice 0: Define the API contract (types, interfaces, OpenAPI spec)
|
|
72
|
+
Slice 1a: Implement backend against the contract + API tests
|
|
73
|
+
Slice 1b: Implement frontend against mock data matching the contract
|
|
74
|
+
Slice 2: Integrate and test end-to-end
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Risk-First Slicing
|
|
78
|
+
|
|
79
|
+
Tackle the riskiest or most uncertain piece first:
|
|
80
|
+
|
|
81
|
+
```
|
|
82
|
+
Slice 1: Prove the WebSocket connection works (highest risk)
|
|
83
|
+
Slice 2: Build real-time task updates on the proven connection
|
|
84
|
+
Slice 3: Add offline support and reconnection
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
If Slice 1 fails, you discover it before investing in Slices 2 and 3.
|
|
88
|
+
|
|
89
|
+
## Implementation Rules
|
|
90
|
+
|
|
91
|
+
### Rule 0: Simplicity First
|
|
92
|
+
|
|
93
|
+
Before writing any code, ask: "What is the simplest thing that could work?"
|
|
94
|
+
|
|
95
|
+
After writing code, review it against these checks:
|
|
96
|
+
- Can this be done in fewer lines?
|
|
97
|
+
- Are these abstractions earning their complexity?
|
|
98
|
+
- Would a staff engineer look at this and say "why didn't you just..."?
|
|
99
|
+
- Am I building for hypothetical future requirements, or the current task?
|
|
100
|
+
|
|
101
|
+
```
|
|
102
|
+
SIMPLICITY CHECK:
|
|
103
|
+
✗ Generic EventBus with middleware pipeline for one notification
|
|
104
|
+
✓ Simple function call
|
|
105
|
+
|
|
106
|
+
✗ Abstract factory pattern for two similar components
|
|
107
|
+
✓ Two straightforward components with shared utilities
|
|
108
|
+
|
|
109
|
+
✗ Config-driven form builder for three forms
|
|
110
|
+
✓ Three form components
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Three similar lines of code is better than a premature abstraction. Implement the naive, obviously-correct version first. Optimize only after correctness is proven with tests.
|
|
114
|
+
|
|
115
|
+
### Rule 0.5: Scope Discipline
|
|
116
|
+
|
|
117
|
+
Touch only what the task requires.
|
|
118
|
+
|
|
119
|
+
Do NOT:
|
|
120
|
+
- "Clean up" code adjacent to your change
|
|
121
|
+
- Refactor imports in files you're not modifying
|
|
122
|
+
- Remove comments you don't fully understand
|
|
123
|
+
- Add features not in the spec because they "seem useful"
|
|
124
|
+
- Modernize syntax in files you're only reading
|
|
125
|
+
|
|
126
|
+
If you notice something worth improving outside your task scope, note it — don't fix it:
|
|
127
|
+
|
|
128
|
+
```
|
|
129
|
+
NOTICED BUT NOT TOUCHING:
|
|
130
|
+
- src/utils/format.ts has an unused import (unrelated to this task)
|
|
131
|
+
- The auth middleware could use better error messages (separate task)
|
|
132
|
+
→ Want me to create tasks for these?
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Rule 1: One Thing at a Time
|
|
136
|
+
|
|
137
|
+
Each increment changes one logical thing. Don't mix concerns:
|
|
138
|
+
|
|
139
|
+
**Bad:** One commit that adds a new component, refactors an existing one, and updates the build config.
|
|
140
|
+
|
|
141
|
+
**Good:** Three separate commits — one for each change.
|
|
142
|
+
|
|
143
|
+
### Rule 2: Keep It Compilable
|
|
144
|
+
|
|
145
|
+
After each increment, the project must build and existing tests must pass. Don't leave the codebase in a broken state between slices.
|
|
146
|
+
|
|
147
|
+
### Rule 3: Feature Flags for Incomplete Features
|
|
148
|
+
|
|
149
|
+
If a feature isn't ready for users but you need to merge increments:
|
|
150
|
+
|
|
151
|
+
```typescript
|
|
152
|
+
// Feature flag for work-in-progress
|
|
153
|
+
const ENABLE_TASK_SHARING = process.env.FEATURE_TASK_SHARING === 'true';
|
|
154
|
+
|
|
155
|
+
if (ENABLE_TASK_SHARING) {
|
|
156
|
+
// New sharing UI
|
|
157
|
+
}
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
This lets you merge small increments to the main branch without exposing incomplete work.
|
|
161
|
+
|
|
162
|
+
### Rule 4: Safe Defaults
|
|
163
|
+
|
|
164
|
+
New code should default to safe, conservative behavior:
|
|
165
|
+
|
|
166
|
+
```typescript
|
|
167
|
+
// Safe: disabled by default, opt-in
|
|
168
|
+
export function createTask(data: TaskInput, options?: { notify?: boolean }) {
|
|
169
|
+
const shouldNotify = options?.notify ?? false;
|
|
170
|
+
// ...
|
|
171
|
+
}
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### Rule 5: Rollback-Friendly
|
|
175
|
+
|
|
176
|
+
Each increment should be independently revertable:
|
|
177
|
+
|
|
178
|
+
- Additive changes (new files, new functions) are easy to revert
|
|
179
|
+
- Modifications to existing code should be minimal and focused
|
|
180
|
+
- Database migrations should have corresponding rollback migrations
|
|
181
|
+
- Avoid deleting something in one commit and replacing it in the same commit — separate them
|
|
182
|
+
|
|
183
|
+
## Working with Agents
|
|
184
|
+
|
|
185
|
+
When directing an agent to implement incrementally:
|
|
186
|
+
|
|
187
|
+
```
|
|
188
|
+
"Let's implement Task 3 from the plan.
|
|
189
|
+
|
|
190
|
+
Start with just the database schema change and the API endpoint.
|
|
191
|
+
Don't touch the UI yet — we'll do that in the next increment.
|
|
192
|
+
|
|
193
|
+
After implementing, run the repository's test and build commands to
|
|
194
|
+
verify nothing is broken."
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
Be explicit about what's in scope and what's NOT in scope for each increment.
|
|
198
|
+
|
|
199
|
+
## Increment Checklist
|
|
200
|
+
|
|
201
|
+
After each increment, verify with the repository's own commands (see the test-driven-development skill's Discover the Stack First section):
|
|
202
|
+
|
|
203
|
+
- [ ] The change does one thing and does it completely
|
|
204
|
+
- [ ] All existing tests still pass (the repository's test command: `npm test`, `./gradlew test`, `pytest`, ...)
|
|
205
|
+
- [ ] The build succeeds (the repository's build command)
|
|
206
|
+
- [ ] Type checking passes, where the stack has one (`npx tsc --noEmit`, `mypy`, ...)
|
|
207
|
+
- [ ] Linting passes (the repository's lint command)
|
|
208
|
+
- [ ] The new functionality works as expected
|
|
209
|
+
- [ ] The change is committed with a descriptive message
|
|
210
|
+
|
|
211
|
+
**Note:** Run each verification command after a change that could affect it. After a successful run, don't repeat the same command unless the code has changed since — re-running on unchanged code adds no information.
|
|
212
|
+
|
|
213
|
+
## Common Rationalizations
|
|
214
|
+
|
|
215
|
+
| Rationalization | Reality |
|
|
216
|
+
|---|---|
|
|
217
|
+
| "I'll test it all at the end" | Bugs compound. A bug in Slice 1 makes Slices 2-5 wrong. Test each slice. |
|
|
218
|
+
| "It's faster to do it all at once" | It *feels* faster until something breaks and you can't find which of 500 changed lines caused it. |
|
|
219
|
+
| "These changes are too small to commit separately" | Small commits are free. Large commits hide bugs and make rollbacks painful. |
|
|
220
|
+
| "I'll add the feature flag later" | If the feature isn't complete, it shouldn't be user-visible. Add the flag now. |
|
|
221
|
+
| "This refactor is small enough to include" | Refactors mixed with features make both harder to review and debug. Separate them. |
|
|
222
|
+
| "Let me run the build command again just to be sure" | After a successful run, repeating the same command adds nothing unless the code has changed since. Run it again after subsequent edits, not as reassurance. |
|
|
223
|
+
|
|
224
|
+
## Red Flags
|
|
225
|
+
|
|
226
|
+
- More than 100 lines of code written without running tests
|
|
227
|
+
- Multiple unrelated changes in a single increment
|
|
228
|
+
- "Let me just quickly add this too" scope expansion
|
|
229
|
+
- Skipping the test/verify step to move faster
|
|
230
|
+
- Build or tests broken between increments
|
|
231
|
+
- Large uncommitted changes accumulating
|
|
232
|
+
- Building abstractions before the third use case demands it
|
|
233
|
+
- Touching files outside the task scope "while I'm here"
|
|
234
|
+
- Creating new utility files for one-time operations
|
|
235
|
+
- Running the same build/test command twice in a row without any intervening code change
|
|
236
|
+
|
|
237
|
+
## Verification
|
|
238
|
+
|
|
239
|
+
After completing all increments for a task:
|
|
240
|
+
|
|
241
|
+
- [ ] Each increment was individually tested and committed
|
|
242
|
+
- [ ] The full test suite passes
|
|
243
|
+
- [ ] The build is clean
|
|
244
|
+
- [ ] The feature works end-to-end as specified
|
|
245
|
+
- [ ] No uncommitted changes remain
|
|
246
|
+
|
|
247
|
+
## See Also
|
|
248
|
+
|
|
249
|
+
Per-increment verification is the local check. Before declaring a task done, apply the project-wide Definition of Done as the final gate, the standing bar every increment clears regardless of the task. See `../references/definition-of-done.md`.
|