@eltonssouza/development-utility-kit 0.15.1 → 0.16.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/.claude/skills/_vendor/NOTICE.md +11 -0
- package/.claude/skills/_vendor/mattpocock-LICENSE +21 -0
- package/.claude/skills/_vendor/vendored.json +15 -0
- package/.claude/skills/diagnose/SKILL.md +117 -0
- package/.claude/skills/diagnose/scripts/hitl-loop.template.sh +41 -0
- package/.claude/skills/grill-with-docs/ADR-FORMAT.md +47 -0
- package/.claude/skills/grill-with-docs/CONTEXT-FORMAT.md +60 -0
- package/.claude/skills/grill-with-docs/SKILL.md +88 -0
- package/.claude/skills/improve-codebase-architecture/DEEPENING.md +37 -0
- package/.claude/skills/improve-codebase-architecture/HTML-REPORT.md +123 -0
- package/.claude/skills/improve-codebase-architecture/INTERFACE-DESIGN.md +44 -0
- package/.claude/skills/improve-codebase-architecture/LANGUAGE.md +53 -0
- package/.claude/skills/improve-codebase-architecture/SKILL.md +81 -0
- package/.claude/skills/prototype/LOGIC.md +79 -0
- package/.claude/skills/prototype/SKILL.md +30 -0
- package/.claude/skills/prototype/UI.md +112 -0
- package/.claude/skills/setup-matt-pocock-skills/SKILL.md +121 -0
- package/.claude/skills/setup-matt-pocock-skills/domain.md +51 -0
- package/.claude/skills/setup-matt-pocock-skills/issue-tracker-github.md +22 -0
- package/.claude/skills/setup-matt-pocock-skills/issue-tracker-gitlab.md +23 -0
- package/.claude/skills/setup-matt-pocock-skills/issue-tracker-local.md +19 -0
- package/.claude/skills/setup-matt-pocock-skills/triage-labels.md +15 -0
- package/.claude/skills/tdd/SKILL.md +109 -0
- package/.claude/skills/tdd/deep-modules.md +33 -0
- package/.claude/skills/tdd/interface-design.md +31 -0
- package/.claude/skills/tdd/mocking.md +59 -0
- package/.claude/skills/tdd/refactoring.md +10 -0
- package/.claude/skills/tdd/tests.md +61 -0
- package/.claude/skills/triage/AGENT-BRIEF.md +168 -0
- package/.claude/skills/triage/OUT-OF-SCOPE.md +101 -0
- package/.claude/skills/triage/SKILL.md +103 -0
- package/.claude/skills/zoom-out/SKILL.md +7 -0
- package/README.repo.md +1 -1
- package/bin/lib/lint.js +16 -1
- package/package.json +1 -1
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: tdd
|
|
3
|
+
description: Test-driven development with red-green-refactor loop. Use when user wants to build features or fix bugs using TDD, mentions "red-green-refactor", wants integration tests, or asks for test-first development.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Test-Driven Development
|
|
7
|
+
|
|
8
|
+
## Philosophy
|
|
9
|
+
|
|
10
|
+
**Core principle**: Tests should verify behavior through public interfaces, not implementation details. Code can change entirely; tests shouldn't.
|
|
11
|
+
|
|
12
|
+
**Good tests** are integration-style: they exercise real code paths through public APIs. They describe _what_ the system does, not _how_ it does it. A good test reads like a specification - "user can checkout with valid cart" tells you exactly what capability exists. These tests survive refactors because they don't care about internal structure.
|
|
13
|
+
|
|
14
|
+
**Bad tests** are coupled to implementation. They mock internal collaborators, test private methods, or verify through external means (like querying a database directly instead of using the interface). The warning sign: your test breaks when you refactor, but behavior hasn't changed. If you rename an internal function and tests fail, those tests were testing implementation, not behavior.
|
|
15
|
+
|
|
16
|
+
See [tests.md](tests.md) for examples and [mocking.md](mocking.md) for mocking guidelines.
|
|
17
|
+
|
|
18
|
+
## Anti-Pattern: Horizontal Slices
|
|
19
|
+
|
|
20
|
+
**DO NOT write all tests first, then all implementation.** This is "horizontal slicing" - treating RED as "write all tests" and GREEN as "write all code."
|
|
21
|
+
|
|
22
|
+
This produces **crap tests**:
|
|
23
|
+
|
|
24
|
+
- Tests written in bulk test _imagined_ behavior, not _actual_ behavior
|
|
25
|
+
- You end up testing the _shape_ of things (data structures, function signatures) rather than user-facing behavior
|
|
26
|
+
- Tests become insensitive to real changes - they pass when behavior breaks, fail when behavior is fine
|
|
27
|
+
- You outrun your headlights, committing to test structure before understanding the implementation
|
|
28
|
+
|
|
29
|
+
**Correct approach**: Vertical slices via tracer bullets. One test → one implementation → repeat. Each test responds to what you learned from the previous cycle. Because you just wrote the code, you know exactly what behavior matters and how to verify it.
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
WRONG (horizontal):
|
|
33
|
+
RED: test1, test2, test3, test4, test5
|
|
34
|
+
GREEN: impl1, impl2, impl3, impl4, impl5
|
|
35
|
+
|
|
36
|
+
RIGHT (vertical):
|
|
37
|
+
RED→GREEN: test1→impl1
|
|
38
|
+
RED→GREEN: test2→impl2
|
|
39
|
+
RED→GREEN: test3→impl3
|
|
40
|
+
...
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Workflow
|
|
44
|
+
|
|
45
|
+
### 1. Planning
|
|
46
|
+
|
|
47
|
+
When exploring the codebase, use the project's domain glossary so that test names and interface vocabulary match the project's language, and respect ADRs in the area you're touching.
|
|
48
|
+
|
|
49
|
+
Before writing any code:
|
|
50
|
+
|
|
51
|
+
- [ ] Confirm with user what interface changes are needed
|
|
52
|
+
- [ ] Confirm with user which behaviors to test (prioritize)
|
|
53
|
+
- [ ] Identify opportunities for [deep modules](deep-modules.md) (small interface, deep implementation)
|
|
54
|
+
- [ ] Design interfaces for [testability](interface-design.md)
|
|
55
|
+
- [ ] List the behaviors to test (not implementation steps)
|
|
56
|
+
- [ ] Get user approval on the plan
|
|
57
|
+
|
|
58
|
+
Ask: "What should the public interface look like? Which behaviors are most important to test?"
|
|
59
|
+
|
|
60
|
+
**You can't test everything.** Confirm with the user exactly which behaviors matter most. Focus testing effort on critical paths and complex logic, not every possible edge case.
|
|
61
|
+
|
|
62
|
+
### 2. Tracer Bullet
|
|
63
|
+
|
|
64
|
+
Write ONE test that confirms ONE thing about the system:
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
RED: Write test for first behavior → test fails
|
|
68
|
+
GREEN: Write minimal code to pass → test passes
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
This is your tracer bullet - proves the path works end-to-end.
|
|
72
|
+
|
|
73
|
+
### 3. Incremental Loop
|
|
74
|
+
|
|
75
|
+
For each remaining behavior:
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
RED: Write next test → fails
|
|
79
|
+
GREEN: Minimal code to pass → passes
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Rules:
|
|
83
|
+
|
|
84
|
+
- One test at a time
|
|
85
|
+
- Only enough code to pass current test
|
|
86
|
+
- Don't anticipate future tests
|
|
87
|
+
- Keep tests focused on observable behavior
|
|
88
|
+
|
|
89
|
+
### 4. Refactor
|
|
90
|
+
|
|
91
|
+
After all tests pass, look for [refactor candidates](refactoring.md):
|
|
92
|
+
|
|
93
|
+
- [ ] Extract duplication
|
|
94
|
+
- [ ] Deepen modules (move complexity behind simple interfaces)
|
|
95
|
+
- [ ] Apply SOLID principles where natural
|
|
96
|
+
- [ ] Consider what new code reveals about existing code
|
|
97
|
+
- [ ] Run tests after each refactor step
|
|
98
|
+
|
|
99
|
+
**Never refactor while RED.** Get to GREEN first.
|
|
100
|
+
|
|
101
|
+
## Checklist Per Cycle
|
|
102
|
+
|
|
103
|
+
```
|
|
104
|
+
[ ] Test describes behavior, not implementation
|
|
105
|
+
[ ] Test uses public interface only
|
|
106
|
+
[ ] Test would survive internal refactor
|
|
107
|
+
[ ] Code is minimal for this test
|
|
108
|
+
[ ] No speculative features added
|
|
109
|
+
```
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Deep Modules
|
|
2
|
+
|
|
3
|
+
From "A Philosophy of Software Design":
|
|
4
|
+
|
|
5
|
+
**Deep module** = small interface + lots of implementation
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
┌─────────────────────┐
|
|
9
|
+
│ Small Interface │ ← Few methods, simple params
|
|
10
|
+
├─────────────────────┤
|
|
11
|
+
│ │
|
|
12
|
+
│ │
|
|
13
|
+
│ Deep Implementation│ ← Complex logic hidden
|
|
14
|
+
│ │
|
|
15
|
+
│ │
|
|
16
|
+
└─────────────────────┘
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
**Shallow module** = large interface + little implementation (avoid)
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
┌─────────────────────────────────┐
|
|
23
|
+
│ Large Interface │ ← Many methods, complex params
|
|
24
|
+
├─────────────────────────────────┤
|
|
25
|
+
│ Thin Implementation │ ← Just passes through
|
|
26
|
+
└─────────────────────────────────┘
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
When designing interfaces, ask:
|
|
30
|
+
|
|
31
|
+
- Can I reduce the number of methods?
|
|
32
|
+
- Can I simplify the parameters?
|
|
33
|
+
- Can I hide more complexity inside?
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Interface Design for Testability
|
|
2
|
+
|
|
3
|
+
Good interfaces make testing natural:
|
|
4
|
+
|
|
5
|
+
1. **Accept dependencies, don't create them**
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
// Testable
|
|
9
|
+
function processOrder(order, paymentGateway) {}
|
|
10
|
+
|
|
11
|
+
// Hard to test
|
|
12
|
+
function processOrder(order) {
|
|
13
|
+
const gateway = new StripeGateway();
|
|
14
|
+
}
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
2. **Return results, don't produce side effects**
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
// Testable
|
|
21
|
+
function calculateDiscount(cart): Discount {}
|
|
22
|
+
|
|
23
|
+
// Hard to test
|
|
24
|
+
function applyDiscount(cart): void {
|
|
25
|
+
cart.total -= discount;
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
3. **Small surface area**
|
|
30
|
+
- Fewer methods = fewer tests needed
|
|
31
|
+
- Fewer params = simpler test setup
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# When to Mock
|
|
2
|
+
|
|
3
|
+
Mock at **system boundaries** only:
|
|
4
|
+
|
|
5
|
+
- External APIs (payment, email, etc.)
|
|
6
|
+
- Databases (sometimes - prefer test DB)
|
|
7
|
+
- Time/randomness
|
|
8
|
+
- File system (sometimes)
|
|
9
|
+
|
|
10
|
+
Don't mock:
|
|
11
|
+
|
|
12
|
+
- Your own classes/modules
|
|
13
|
+
- Internal collaborators
|
|
14
|
+
- Anything you control
|
|
15
|
+
|
|
16
|
+
## Designing for Mockability
|
|
17
|
+
|
|
18
|
+
At system boundaries, design interfaces that are easy to mock:
|
|
19
|
+
|
|
20
|
+
**1. Use dependency injection**
|
|
21
|
+
|
|
22
|
+
Pass external dependencies in rather than creating them internally:
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
// Easy to mock
|
|
26
|
+
function processPayment(order, paymentClient) {
|
|
27
|
+
return paymentClient.charge(order.total);
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
// Hard to mock
|
|
31
|
+
function processPayment(order) {
|
|
32
|
+
const client = new StripeClient(process.env.STRIPE_KEY);
|
|
33
|
+
return client.charge(order.total);
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
**2. Prefer SDK-style interfaces over generic fetchers**
|
|
38
|
+
|
|
39
|
+
Create specific functions for each external operation instead of one generic function with conditional logic:
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
// GOOD: Each function is independently mockable
|
|
43
|
+
const api = {
|
|
44
|
+
getUser: (id) => fetch(`/users/${id}`),
|
|
45
|
+
getOrders: (userId) => fetch(`/users/${userId}/orders`),
|
|
46
|
+
createOrder: (data) => fetch('/orders', { method: 'POST', body: data }),
|
|
47
|
+
};
|
|
48
|
+
|
|
49
|
+
// BAD: Mocking requires conditional logic inside the mock
|
|
50
|
+
const api = {
|
|
51
|
+
fetch: (endpoint, options) => fetch(endpoint, options),
|
|
52
|
+
};
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
The SDK approach means:
|
|
56
|
+
- Each mock returns one specific shape
|
|
57
|
+
- No conditional logic in test setup
|
|
58
|
+
- Easier to see which endpoints a test exercises
|
|
59
|
+
- Type safety per endpoint
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Refactor Candidates
|
|
2
|
+
|
|
3
|
+
After TDD cycle, look for:
|
|
4
|
+
|
|
5
|
+
- **Duplication** → Extract function/class
|
|
6
|
+
- **Long methods** → Break into private helpers (keep tests on public interface)
|
|
7
|
+
- **Shallow modules** → Combine or deepen
|
|
8
|
+
- **Feature envy** → Move logic to where data lives
|
|
9
|
+
- **Primitive obsession** → Introduce value objects
|
|
10
|
+
- **Existing code** the new code reveals as problematic
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Good and Bad Tests
|
|
2
|
+
|
|
3
|
+
## Good Tests
|
|
4
|
+
|
|
5
|
+
**Integration-style**: Test through real interfaces, not mocks of internal parts.
|
|
6
|
+
|
|
7
|
+
```typescript
|
|
8
|
+
// GOOD: Tests observable behavior
|
|
9
|
+
test("user can checkout with valid cart", async () => {
|
|
10
|
+
const cart = createCart();
|
|
11
|
+
cart.add(product);
|
|
12
|
+
const result = await checkout(cart, paymentMethod);
|
|
13
|
+
expect(result.status).toBe("confirmed");
|
|
14
|
+
});
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Characteristics:
|
|
18
|
+
|
|
19
|
+
- Tests behavior users/callers care about
|
|
20
|
+
- Uses public API only
|
|
21
|
+
- Survives internal refactors
|
|
22
|
+
- Describes WHAT, not HOW
|
|
23
|
+
- One logical assertion per test
|
|
24
|
+
|
|
25
|
+
## Bad Tests
|
|
26
|
+
|
|
27
|
+
**Implementation-detail tests**: Coupled to internal structure.
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
// BAD: Tests implementation details
|
|
31
|
+
test("checkout calls paymentService.process", async () => {
|
|
32
|
+
const mockPayment = jest.mock(paymentService);
|
|
33
|
+
await checkout(cart, payment);
|
|
34
|
+
expect(mockPayment.process).toHaveBeenCalledWith(cart.total);
|
|
35
|
+
});
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Red flags:
|
|
39
|
+
|
|
40
|
+
- Mocking internal collaborators
|
|
41
|
+
- Testing private methods
|
|
42
|
+
- Asserting on call counts/order
|
|
43
|
+
- Test breaks when refactoring without behavior change
|
|
44
|
+
- Test name describes HOW not WHAT
|
|
45
|
+
- Verifying through external means instead of interface
|
|
46
|
+
|
|
47
|
+
```typescript
|
|
48
|
+
// BAD: Bypasses interface to verify
|
|
49
|
+
test("createUser saves to database", async () => {
|
|
50
|
+
await createUser({ name: "Alice" });
|
|
51
|
+
const row = await db.query("SELECT * FROM users WHERE name = ?", ["Alice"]);
|
|
52
|
+
expect(row).toBeDefined();
|
|
53
|
+
});
|
|
54
|
+
|
|
55
|
+
// GOOD: Verifies through interface
|
|
56
|
+
test("createUser makes user retrievable", async () => {
|
|
57
|
+
const user = await createUser({ name: "Alice" });
|
|
58
|
+
const retrieved = await getUser(user.id);
|
|
59
|
+
expect(retrieved.name).toBe("Alice");
|
|
60
|
+
});
|
|
61
|
+
```
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
# Writing Agent Briefs
|
|
2
|
+
|
|
3
|
+
An agent brief is a structured comment posted on a GitHub issue when it moves to `ready-for-agent`. It is the authoritative specification that an AFK agent will work from. The original issue body and discussion are context — the agent brief is the contract.
|
|
4
|
+
|
|
5
|
+
## Principles
|
|
6
|
+
|
|
7
|
+
### Durability over precision
|
|
8
|
+
|
|
9
|
+
The issue may sit in `ready-for-agent` for days or weeks. The codebase will change in the meantime. Write the brief so it stays useful even as files are renamed, moved, or refactored.
|
|
10
|
+
|
|
11
|
+
- **Do** describe interfaces, types, and behavioral contracts
|
|
12
|
+
- **Do** name specific types, function signatures, or config shapes that the agent should look for or modify
|
|
13
|
+
- **Don't** reference file paths — they go stale
|
|
14
|
+
- **Don't** reference line numbers
|
|
15
|
+
- **Don't** assume the current implementation structure will remain the same
|
|
16
|
+
|
|
17
|
+
### Behavioral, not procedural
|
|
18
|
+
|
|
19
|
+
Describe **what** the system should do, not **how** to implement it. The agent will explore the codebase fresh and make its own implementation decisions.
|
|
20
|
+
|
|
21
|
+
- **Good:** "The `SkillConfig` type should accept an optional `schedule` field of type `CronExpression`"
|
|
22
|
+
- **Bad:** "Open src/types/skill.ts and add a schedule field on line 42"
|
|
23
|
+
- **Good:** "When a user runs `/triage` with no arguments, they should see a summary of issues needing attention"
|
|
24
|
+
- **Bad:** "Add a switch statement in the main handler function"
|
|
25
|
+
|
|
26
|
+
### Complete acceptance criteria
|
|
27
|
+
|
|
28
|
+
The agent needs to know when it's done. Every agent brief must have concrete, testable acceptance criteria. Each criterion should be independently verifiable.
|
|
29
|
+
|
|
30
|
+
- **Good:** "Running `gh issue list --label needs-triage` returns issues that have been through initial classification"
|
|
31
|
+
- **Bad:** "Triage should work correctly"
|
|
32
|
+
|
|
33
|
+
### Explicit scope boundaries
|
|
34
|
+
|
|
35
|
+
State what is out of scope. This prevents the agent from gold-plating or making assumptions about adjacent features.
|
|
36
|
+
|
|
37
|
+
## Template
|
|
38
|
+
|
|
39
|
+
```markdown
|
|
40
|
+
## Agent Brief
|
|
41
|
+
|
|
42
|
+
**Category:** bug / enhancement
|
|
43
|
+
**Summary:** one-line description of what needs to happen
|
|
44
|
+
|
|
45
|
+
**Current behavior:**
|
|
46
|
+
Describe what happens now. For bugs, this is the broken behavior.
|
|
47
|
+
For enhancements, this is the status quo the feature builds on.
|
|
48
|
+
|
|
49
|
+
**Desired behavior:**
|
|
50
|
+
Describe what should happen after the agent's work is complete.
|
|
51
|
+
Be specific about edge cases and error conditions.
|
|
52
|
+
|
|
53
|
+
**Key interfaces:**
|
|
54
|
+
- `TypeName` — what needs to change and why
|
|
55
|
+
- `functionName()` return type — what it currently returns vs what it should return
|
|
56
|
+
- Config shape — any new configuration options needed
|
|
57
|
+
|
|
58
|
+
**Acceptance criteria:**
|
|
59
|
+
- [ ] Specific, testable criterion 1
|
|
60
|
+
- [ ] Specific, testable criterion 2
|
|
61
|
+
- [ ] Specific, testable criterion 3
|
|
62
|
+
|
|
63
|
+
**Out of scope:**
|
|
64
|
+
- Thing that should NOT be changed or addressed in this issue
|
|
65
|
+
- Adjacent feature that might seem related but is separate
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Examples
|
|
69
|
+
|
|
70
|
+
### Good agent brief (bug)
|
|
71
|
+
|
|
72
|
+
```markdown
|
|
73
|
+
## Agent Brief
|
|
74
|
+
|
|
75
|
+
**Category:** bug
|
|
76
|
+
**Summary:** Skill description truncation drops mid-word, producing broken output
|
|
77
|
+
|
|
78
|
+
**Current behavior:**
|
|
79
|
+
When a skill description exceeds 1024 characters, it is truncated at exactly
|
|
80
|
+
1024 characters regardless of word boundaries. This produces descriptions
|
|
81
|
+
that end mid-word (e.g. "Use when the user wants to confi").
|
|
82
|
+
|
|
83
|
+
**Desired behavior:**
|
|
84
|
+
Truncation should break at the last word boundary before 1024 characters
|
|
85
|
+
and append "..." to indicate truncation.
|
|
86
|
+
|
|
87
|
+
**Key interfaces:**
|
|
88
|
+
- The `SkillMetadata` type's `description` field — no type change needed,
|
|
89
|
+
but the validation/processing logic that populates it needs to respect
|
|
90
|
+
word boundaries
|
|
91
|
+
- Any function that reads SKILL.md frontmatter and extracts the description
|
|
92
|
+
|
|
93
|
+
**Acceptance criteria:**
|
|
94
|
+
- [ ] Descriptions under 1024 chars are unchanged
|
|
95
|
+
- [ ] Descriptions over 1024 chars are truncated at the last word boundary
|
|
96
|
+
before 1024 chars
|
|
97
|
+
- [ ] Truncated descriptions end with "..."
|
|
98
|
+
- [ ] The total length including "..." does not exceed 1024 chars
|
|
99
|
+
|
|
100
|
+
**Out of scope:**
|
|
101
|
+
- Changing the 1024 char limit itself
|
|
102
|
+
- Multi-line description support
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Good agent brief (enhancement)
|
|
106
|
+
|
|
107
|
+
```markdown
|
|
108
|
+
## Agent Brief
|
|
109
|
+
|
|
110
|
+
**Category:** enhancement
|
|
111
|
+
**Summary:** Add `.out-of-scope/` directory support for tracking rejected feature requests
|
|
112
|
+
|
|
113
|
+
**Current behavior:**
|
|
114
|
+
When a feature request is rejected, the issue is closed with a `wontfix` label
|
|
115
|
+
and a comment. There is no persistent record of the decision or reasoning.
|
|
116
|
+
Future similar requests require the maintainer to recall or search for the
|
|
117
|
+
prior discussion.
|
|
118
|
+
|
|
119
|
+
**Desired behavior:**
|
|
120
|
+
Rejected feature requests should be documented in `.out-of-scope/<concept>.md`
|
|
121
|
+
files that capture the decision, reasoning, and links to all issues that
|
|
122
|
+
requested the feature. When triaging new issues, these files should be
|
|
123
|
+
checked for matches.
|
|
124
|
+
|
|
125
|
+
**Key interfaces:**
|
|
126
|
+
- Markdown file format in `.out-of-scope/` — each file should have a
|
|
127
|
+
`# Concept Name` heading, a `**Decision:**` line, a `**Reason:**` line,
|
|
128
|
+
and a `**Prior requests:**` list with issue links
|
|
129
|
+
- The triage workflow should read all `.out-of-scope/*.md` files early
|
|
130
|
+
and match incoming issues against them by concept similarity
|
|
131
|
+
|
|
132
|
+
**Acceptance criteria:**
|
|
133
|
+
- [ ] Closing a feature as wontfix creates/updates a file in `.out-of-scope/`
|
|
134
|
+
- [ ] The file includes the decision, reasoning, and link to the closed issue
|
|
135
|
+
- [ ] If a matching `.out-of-scope/` file already exists, the new issue is
|
|
136
|
+
appended to its "Prior requests" list rather than creating a duplicate
|
|
137
|
+
- [ ] During triage, existing `.out-of-scope/` files are checked and surfaced
|
|
138
|
+
when a new issue matches a prior rejection
|
|
139
|
+
|
|
140
|
+
**Out of scope:**
|
|
141
|
+
- Automated matching (human confirms the match)
|
|
142
|
+
- Reopening previously rejected features
|
|
143
|
+
- Bug reports (only enhancement rejections go to `.out-of-scope/`)
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Bad agent brief
|
|
147
|
+
|
|
148
|
+
```markdown
|
|
149
|
+
## Agent Brief
|
|
150
|
+
|
|
151
|
+
**Summary:** Fix the triage bug
|
|
152
|
+
|
|
153
|
+
**What to do:**
|
|
154
|
+
The triage thing is broken. Look at the main file and fix it.
|
|
155
|
+
The function around line 150 has the issue.
|
|
156
|
+
|
|
157
|
+
**Files to change:**
|
|
158
|
+
- src/triage/handler.ts (line 150)
|
|
159
|
+
- src/types.ts (line 42)
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
This is bad because:
|
|
163
|
+
- No category
|
|
164
|
+
- Vague description ("the triage thing is broken")
|
|
165
|
+
- References file paths and line numbers that will go stale
|
|
166
|
+
- No acceptance criteria
|
|
167
|
+
- No scope boundaries
|
|
168
|
+
- No description of current vs desired behavior
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# Out-of-Scope Knowledge Base
|
|
2
|
+
|
|
3
|
+
The `.out-of-scope/` directory in a repo stores persistent records of rejected feature requests. It serves two purposes:
|
|
4
|
+
|
|
5
|
+
1. **Institutional memory** — why a feature was rejected, so the reasoning isn't lost when the issue is closed
|
|
6
|
+
2. **Deduplication** — when a new issue comes in that matches a prior rejection, the skill can surface the previous decision instead of re-litigating it
|
|
7
|
+
|
|
8
|
+
## Directory structure
|
|
9
|
+
|
|
10
|
+
```
|
|
11
|
+
.out-of-scope/
|
|
12
|
+
├── dark-mode.md
|
|
13
|
+
├── plugin-system.md
|
|
14
|
+
└── graphql-api.md
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
One file per **concept**, not per issue. Multiple issues requesting the same thing are grouped under one file.
|
|
18
|
+
|
|
19
|
+
## File format
|
|
20
|
+
|
|
21
|
+
The file should be written in a relaxed, readable style — more like a short design document than a database entry. Use paragraphs, code samples, and examples to make the reasoning clear and useful to someone encountering it for the first time.
|
|
22
|
+
|
|
23
|
+
```markdown
|
|
24
|
+
# Dark Mode
|
|
25
|
+
|
|
26
|
+
This project does not support dark mode or user-facing theming.
|
|
27
|
+
|
|
28
|
+
## Why this is out of scope
|
|
29
|
+
|
|
30
|
+
The rendering pipeline assumes a single color palette defined in
|
|
31
|
+
`ThemeConfig`. Supporting multiple themes would require:
|
|
32
|
+
|
|
33
|
+
- A theme context provider wrapping the entire component tree
|
|
34
|
+
- Per-component theme-aware style resolution
|
|
35
|
+
- A persistence layer for user theme preferences
|
|
36
|
+
|
|
37
|
+
This is a significant architectural change that doesn't align with the
|
|
38
|
+
project's focus on content authoring. Theming is a concern for downstream
|
|
39
|
+
consumers who embed or redistribute the output.
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
// The current ThemeConfig interface is not designed for runtime switching:
|
|
43
|
+
interface ThemeConfig {
|
|
44
|
+
colors: ColorPalette; // single palette, resolved at build time
|
|
45
|
+
fonts: FontStack;
|
|
46
|
+
}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Prior requests
|
|
50
|
+
|
|
51
|
+
- #42 — "Add dark mode support"
|
|
52
|
+
- #87 — "Night theme for accessibility"
|
|
53
|
+
- #134 — "Dark theme option"
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Naming the file
|
|
57
|
+
|
|
58
|
+
Use a short, descriptive kebab-case name for the concept: `dark-mode.md`, `plugin-system.md`, `graphql-api.md`. The name should be recognizable enough that someone browsing the directory understands what was rejected without opening the file.
|
|
59
|
+
|
|
60
|
+
### Writing the reason
|
|
61
|
+
|
|
62
|
+
The reason should be substantive — not "we don't want this" but why. Good reasons reference:
|
|
63
|
+
|
|
64
|
+
- Project scope or philosophy ("This project focuses on X; theming is a downstream concern")
|
|
65
|
+
- Technical constraints ("Supporting this would require Y, which conflicts with our Z architecture")
|
|
66
|
+
- Strategic decisions ("We chose to use A instead of B because...")
|
|
67
|
+
|
|
68
|
+
The reason should be durable. Avoid referencing temporary circumstances ("we're too busy right now") — those aren't real rejections, they're deferrals.
|
|
69
|
+
|
|
70
|
+
## When to check `.out-of-scope/`
|
|
71
|
+
|
|
72
|
+
During triage (Step 1: Gather context), read all files in `.out-of-scope/`. When evaluating a new issue:
|
|
73
|
+
|
|
74
|
+
- Check if the request matches an existing out-of-scope concept
|
|
75
|
+
- Matching is by concept similarity, not keyword — "night theme" matches `dark-mode.md`
|
|
76
|
+
- If there's a match, surface it to the maintainer: "This is similar to `.out-of-scope/dark-mode.md` — we rejected this before because [reason]. Do you still feel the same way?"
|
|
77
|
+
|
|
78
|
+
The maintainer may:
|
|
79
|
+
|
|
80
|
+
- **Confirm** — the new issue gets added to the existing file's "Prior requests" list, then closed
|
|
81
|
+
- **Reconsider** — the out-of-scope file gets deleted or updated, and the issue proceeds through normal triage
|
|
82
|
+
- **Disagree** — the issues are related but distinct, proceed with normal triage
|
|
83
|
+
|
|
84
|
+
## When to write to `.out-of-scope/`
|
|
85
|
+
|
|
86
|
+
Only when an **enhancement** (not a bug) is rejected as `wontfix`. The flow:
|
|
87
|
+
|
|
88
|
+
1. Maintainer decides a feature request is out of scope
|
|
89
|
+
2. Check if a matching `.out-of-scope/` file already exists
|
|
90
|
+
3. If yes: append the new issue to the "Prior requests" list
|
|
91
|
+
4. If no: create a new file with the concept name, decision, reason, and first prior request
|
|
92
|
+
5. Post a comment on the issue explaining the decision and mentioning the `.out-of-scope/` file
|
|
93
|
+
6. Close the issue with the `wontfix` label
|
|
94
|
+
|
|
95
|
+
## Updating or removing out-of-scope files
|
|
96
|
+
|
|
97
|
+
If the maintainer changes their mind about a previously rejected concept:
|
|
98
|
+
|
|
99
|
+
- Delete the `.out-of-scope/` file
|
|
100
|
+
- The skill does not need to reopen old issues — they're historical records
|
|
101
|
+
- The new issue that triggered the reconsideration proceeds through normal triage
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: triage
|
|
3
|
+
description: Triage issues through a state machine driven by triage roles. Use when user wants to create an issue, triage issues, review incoming bugs or feature requests, prepare issues for an AFK agent, or manage issue workflow.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Triage
|
|
7
|
+
|
|
8
|
+
Move issues on the project issue tracker through a small state machine of triage roles.
|
|
9
|
+
|
|
10
|
+
Every comment or issue posted to the issue tracker during triage **must** start with this disclaimer:
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
> *This was generated by AI during triage.*
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Reference docs
|
|
17
|
+
|
|
18
|
+
- [AGENT-BRIEF.md](AGENT-BRIEF.md) — how to write durable agent briefs
|
|
19
|
+
- [OUT-OF-SCOPE.md](OUT-OF-SCOPE.md) — how the `.out-of-scope/` knowledge base works
|
|
20
|
+
|
|
21
|
+
## Roles
|
|
22
|
+
|
|
23
|
+
Two **category** roles:
|
|
24
|
+
|
|
25
|
+
- `bug` — something is broken
|
|
26
|
+
- `enhancement` — new feature or improvement
|
|
27
|
+
|
|
28
|
+
Five **state** roles:
|
|
29
|
+
|
|
30
|
+
- `needs-triage` — maintainer needs to evaluate
|
|
31
|
+
- `needs-info` — waiting on reporter for more information
|
|
32
|
+
- `ready-for-agent` — fully specified, ready for an AFK agent
|
|
33
|
+
- `ready-for-human` — needs human implementation
|
|
34
|
+
- `wontfix` — will not be actioned
|
|
35
|
+
|
|
36
|
+
Every triaged issue should carry exactly one category role and one state role. If state roles conflict, flag it and ask the maintainer before doing anything else.
|
|
37
|
+
|
|
38
|
+
These are canonical role names — the actual label strings used in the issue tracker may differ. The mapping should have been provided to you - run `/setup-matt-pocock-skills` if not.
|
|
39
|
+
|
|
40
|
+
State transitions: an unlabeled issue normally goes to `needs-triage` first; from there it moves to `needs-info`, `ready-for-agent`, `ready-for-human`, or `wontfix`. `needs-info` returns to `needs-triage` once the reporter replies. The maintainer can override at any time — flag transitions that look unusual and ask before proceeding.
|
|
41
|
+
|
|
42
|
+
## Invocation
|
|
43
|
+
|
|
44
|
+
The maintainer invokes `/triage` and describes what they want in natural language. Interpret the request and act. Examples:
|
|
45
|
+
|
|
46
|
+
- "Show me anything that needs my attention"
|
|
47
|
+
- "Let's look at #42"
|
|
48
|
+
- "Move #42 to ready-for-agent"
|
|
49
|
+
- "What's ready for agents to pick up?"
|
|
50
|
+
|
|
51
|
+
## Show what needs attention
|
|
52
|
+
|
|
53
|
+
Query the issue tracker and present three buckets, oldest first:
|
|
54
|
+
|
|
55
|
+
1. **Unlabeled** — never triaged.
|
|
56
|
+
2. **`needs-triage`** — evaluation in progress.
|
|
57
|
+
3. **`needs-info` with reporter activity since the last triage notes** — needs re-evaluation.
|
|
58
|
+
|
|
59
|
+
Show counts and a one-line summary per issue. Let the maintainer pick.
|
|
60
|
+
|
|
61
|
+
## Triage a specific issue
|
|
62
|
+
|
|
63
|
+
1. **Gather context.** Read the full issue (body, comments, labels, reporter, dates). Parse any prior triage notes so you don't re-ask resolved questions. Explore the codebase using the project's domain glossary, respecting ADRs in the area. Read `.out-of-scope/*.md` and surface any prior rejection that resembles this issue.
|
|
64
|
+
|
|
65
|
+
2. **Recommend.** Tell the maintainer your category and state recommendation with reasoning, plus a brief codebase summary relevant to the issue. Wait for direction.
|
|
66
|
+
|
|
67
|
+
3. **Reproduce (bugs only).** Before any grilling, attempt reproduction: read the reporter's steps, trace the relevant code, run tests or commands. Report what happened — successful repro with code path, failed repro, or insufficient detail (a strong `needs-info` signal). A confirmed repro makes a much stronger agent brief.
|
|
68
|
+
|
|
69
|
+
4. **Grill (if needed).** If the issue needs fleshing out, run a `/grill-with-docs` session.
|
|
70
|
+
|
|
71
|
+
5. **Apply the outcome:**
|
|
72
|
+
- `ready-for-agent` — post an agent brief comment ([AGENT-BRIEF.md](AGENT-BRIEF.md)).
|
|
73
|
+
- `ready-for-human` — same structure as an agent brief, but note why it can't be delegated (judgment calls, external access, design decisions, manual testing).
|
|
74
|
+
- `needs-info` — post triage notes (template below).
|
|
75
|
+
- `wontfix` (bug) — polite explanation, then close.
|
|
76
|
+
- `wontfix` (enhancement) — write to `.out-of-scope/`, link to it from a comment, then close ([OUT-OF-SCOPE.md](OUT-OF-SCOPE.md)).
|
|
77
|
+
- `needs-triage` — apply the role. Optional comment if there's partial progress.
|
|
78
|
+
|
|
79
|
+
## Quick state override
|
|
80
|
+
|
|
81
|
+
If the maintainer says "move #42 to ready-for-agent", trust them and apply the role directly. Confirm what you're about to do (role changes, comment, close), then act. Skip grilling. If moving to `ready-for-agent` without a grilling session, ask whether they want to write an agent brief.
|
|
82
|
+
|
|
83
|
+
## Needs-info template
|
|
84
|
+
|
|
85
|
+
```markdown
|
|
86
|
+
## Triage Notes
|
|
87
|
+
|
|
88
|
+
**What we've established so far:**
|
|
89
|
+
|
|
90
|
+
- point 1
|
|
91
|
+
- point 2
|
|
92
|
+
|
|
93
|
+
**What we still need from you (@reporter):**
|
|
94
|
+
|
|
95
|
+
- question 1
|
|
96
|
+
- question 2
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Capture everything resolved during grilling under "established so far" so the work isn't lost. Questions must be specific and actionable, not "please provide more info".
|
|
100
|
+
|
|
101
|
+
## Resuming a previous session
|
|
102
|
+
|
|
103
|
+
If prior triage notes exist on the issue, read them, check whether the reporter has answered any outstanding questions, and present an updated picture before continuing. Don't re-ask resolved questions.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: zoom-out
|
|
3
|
+
description: Tell the agent to zoom out and give broader context or a higher-level perspective. Use when you're unfamiliar with a section of code or need to understand how it fits into the bigger picture.
|
|
4
|
+
disable-model-invocation: true
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
I don't know this area of code well. Go up a layer of abstraction. Give me a map of all the relevant modules and callers, using the project's domain glossary vocabulary.
|