specweave 0.1.6 → 0.1.8

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.
@@ -1,347 +0,0 @@
1
- # /close-increment - Close Increment with Leftover Transfer
2
-
3
- **Command**: `/close-increment <increment-id> [options]`
4
-
5
- **Purpose**: Close an increment that has completed all P1 tasks, with automatic leftover transfer for P2/P3 tasks
6
-
7
- **Framework**: Framework-agnostic (works with all tech stacks)
8
-
9
- ---
10
-
11
- ## Usage
12
-
13
- ```bash
14
- /close-increment 001 # Close increment 001
15
- /close-increment 001 --force # Skip validation (use sparingly)
16
- /close-increment 001 --no-transfer # Cancel leftovers instead of transferring
17
- ```
18
-
19
- ## Arguments
20
-
21
- - `<increment-id>` (required): Increment number (e.g., `001`, `002`)
22
- - `--force` (optional): Skip P1 completion validation
23
- - `--no-transfer` (optional): Cancel leftover tasks instead of transferring
24
-
25
- ---
26
-
27
- ## Workflow
28
-
29
- ### Step 1: Validate Increment Status
30
-
31
- Check if increment can be closed:
32
-
33
- ```
34
- ✅ Validating increment 001-core-framework...
35
-
36
- Criteria:
37
- → All P1 tasks completed? [Checking...]
38
- → All tests passing? [Checking...]
39
- → Documentation updated? [Checking...]
40
- ```
41
-
42
- **If P1 tasks incomplete**:
43
- ```
44
- ❌ Cannot close: 3 P1 tasks remaining
45
-
46
- Incomplete P1 tasks:
47
- - T020: Implement skill-router core logic
48
- - T025: Add E2E tests for context-loader
49
- - T030: Create installation script
50
-
51
- Options:
52
- A) Complete P1 tasks first (recommended)
53
- B) Downgrade to P2 (if justified - requires explanation)
54
- C) Force close with --force (not recommended - breaks commitment)
55
-
56
- Your choice?
57
- ```
58
-
59
- **If validation passes**:
60
- ```
61
- ✅ Ready to close 001-core-framework
62
-
63
- Completion: 88% (44/50 tasks)
64
- P1 tasks: 100% (30/30) ✅
65
- P2 tasks: 80% (12/15) - 3 remaining
66
- P3 tasks: 40% (2/5) - 3 remaining
67
- ```
68
-
69
- ### Step 2: Identify Leftovers
70
-
71
- Scan `tasks.md` for incomplete tasks:
72
-
73
- ```
74
- Found 6 leftover tasks:
75
-
76
- P2 Priority (3 tasks):
77
- - T045: Add caching to context-loader
78
- - T046: Add retry logic to skill-router
79
- - T047: Improve error messages
80
-
81
- P3 Priority (3 tasks):
82
- - T048: Add usage analytics
83
- - T049: Create performance dashboard
84
- - T050: Add debug mode
85
-
86
- Total leftovers: 6 tasks
87
- ```
88
-
89
- ### Step 3: Present Transfer Options
90
-
91
- ```
92
- Transfer options for 6 leftover tasks:
93
-
94
- A) Create new increment "002-enhancements" (recommended)
95
- - All 6 tasks transferred to new increment
96
- - Clean separation of MVP vs enhancements
97
-
98
- B) Add to existing increment
99
- Available increments:
100
- - 002-brownfield-tools [planned] (15 tasks)
101
- - 003-jira-integration [planned] (20 tasks)
102
-
103
- C) Cancel leftovers (document why each canceled)
104
- - Tasks marked as [C] in 001/tasks.md
105
- - Reasons documented in closure report
106
-
107
- D) Mix (transfer some, cancel others)
108
- - You'll be prompted for each task
109
-
110
- Your choice? [A/B/C/D]:
111
- ```
112
-
113
- ### Step 4: Execute Transfer
114
-
115
- **If option A (new increment)**:
116
- ```
117
- Creating increment 002-enhancements...
118
-
119
- → Creating .specweave/increments/0002-enhancements/
120
- → Creating spec.md with transferred tasks
121
- → Creating tasks.md with 6 tasks
122
- → Marking tasks in 001 as [T] Transferred
123
-
124
- ✅ 6 tasks transferred to 002-enhancements
125
- ```
126
-
127
- **002-enhancements/spec.md**:
128
- ```yaml
129
- ---
130
- increment: 002-enhancements
131
- title: "Enhancements from 001-core-framework"
132
- priority: P2
133
- status: planned
134
- created: 2025-10-26
135
- transferred_from: 001-core-framework
136
- transfer_date: 2025-10-26
137
- ---
138
-
139
- # Enhancements from 001-core-framework
140
-
141
- **Transferred tasks** (6 tasks from 001):
142
-
143
- ## User Stories
144
-
145
- ### US1: Performance Optimizations (P2)
146
- - T045: Add caching to context-loader
147
- - T046: Add retry logic to skill-router
148
-
149
- ### US2: Monitoring & Analytics (P3)
150
- - T048: Add usage analytics
151
- - T049: Create performance dashboard
152
- - T050: Add debug mode
153
- ```
154
-
155
- **002-enhancements/tasks.md**:
156
- ```markdown
157
- ## Transferred Tasks (from 001-core-framework)
158
-
159
- ### T001: Add caching to context-loader
160
- **Transferred from**: 001-core-framework (T045)
161
- **Transfer date**: 2025-10-26
162
- **Original priority**: P2
163
- **Current priority**: P1 (promoted - critical for performance)
164
- **Estimated**: 1 day
165
- **Status**: [ ] Pending
166
-
167
- **Implementation**:
168
- [Details from original task]
169
- ```
170
-
171
- ### Step 5: Generate Closure Report
172
-
173
- **File**: `.specweave/increments/0001-core-framework/reports/closure-report.md`
174
-
175
- ```markdown
176
- # Increment Closure Report
177
-
178
- **Increment**: 001-core-framework
179
- **Closed Date**: 2025-10-26
180
- **Duration**: 3 months (2025-01-25 to 2025-10-26)
181
- **Status**: completed → closed
182
-
183
- ## Completion Summary
184
-
185
- | Category | Planned | Completed | Remaining | Rate |
186
- |----------|---------|-----------|-----------|------|
187
- | P1 Tasks | 30 | 30 | 0 | 100% ✅ |
188
- | P2 Tasks | 15 | 12 | 3 | 80% |
189
- | P3 Tasks | 5 | 2 | 3 | 40% |
190
- | **Total** | **50** | **44** | **6** | **88%** |
191
-
192
- ## Transferred Tasks
193
-
194
- ### Transferred to 002-enhancements (6 tasks)
195
-
196
- | Task ID | Description | Priority | Transfer Reason |
197
- |---------|-------------|----------|-----------------|
198
- | T045 | Add caching to context-loader | P2 | Performance optimization, not blocking MVP |
199
- | T046 | Add retry logic to skill-router | P2 | Error handling enhancement |
200
- | T047 | Improve error messages | P2 | UX improvement, not critical |
201
- | T048 | Add usage analytics | P3 | Monitoring feature, nice-to-have |
202
- | T049 | Create performance dashboard | P3 | Visualization, future enhancement |
203
- | T050 | Add debug mode | P3 | Developer tool, not user-facing |
204
-
205
- ## Retrospective
206
-
207
- **What went well**:
208
- - ✅ Clear spec upfront reduced scope creep
209
- - ✅ Test-first approach caught bugs early
210
- - ✅ WIP limits improved focus
211
- - ✅ Context manifests reduced token usage 70%
212
-
213
- **What to improve**:
214
- - ⚠️ Better task estimation (underestimated agent testing by 50%)
215
- - ⚠️ More frequent reviews (caught design issues late)
216
- - ⚠️ Earlier integration testing (found edge cases late)
217
-
218
- **Metrics**:
219
- - Lines of code: 15,000
220
- - Test coverage: 85%
221
- - Token reduction: 72% (context loading)
222
- - Agents created: 20
223
- - Skills created: 24
224
-
225
- ## Sign-off
226
-
227
- - [x] All P1 tasks completed (30/30)
228
- - [x] All tests passing (150/150)
229
- - [x] Documentation updated (API ref, guides)
230
- - [x] Leftovers transferred to 002-enhancements
231
- - [x] Retrospective completed
232
-
233
- **Closed by**: SpecWeave Core Team
234
- **Date**: 2025-10-26
235
- ```
236
-
237
- ### Step 6: Update Source Increment
238
-
239
- Mark transferred tasks in `001-core-framework/tasks.md`:
240
-
241
- ```markdown
242
- ### T045: Add caching to context-loader
243
- **Status**: [T] Transferred to 002-enhancements (T001)
244
- **Transfer date**: 2025-10-26
245
- **Transfer reason**: Performance optimization, deferred to focus on P1 MVP completion
246
- ```
247
-
248
- Update `001-core-framework/spec.md` frontmatter:
249
-
250
- ```yaml
251
- ---
252
- status: closed # ← Changed from "in-progress"
253
- closed: 2025-10-26 # ← Closure date
254
- transferred_to: 002-enhancements # ← Where leftovers went
255
- transferred_tasks: 6
256
- completion_rate: 88
257
- ---
258
- ```
259
-
260
- ### Step 7: Free WIP Slot
261
-
262
- ```
263
- ✅ Increment 001-core-framework closed successfully
264
-
265
- Summary:
266
- → Completion: 88% (44/50 tasks)
267
- → P1 completion: 100% (30/30) ✅
268
- → Leftovers transferred: 6 tasks → 002-enhancements
269
- → Closure report: .specweave/increments/0001-core-framework/reports/closure-report.md
270
- → Status: closed
271
- → WIP freed: 2/2 → 1/2
272
-
273
- You can now start a new increment!
274
- ```
275
-
276
- ---
277
-
278
- ## Validation Rules
279
-
280
- ### Must Complete Before Closing
281
-
282
- - ✅ **All P1 tasks** completed (100%)
283
- - ✅ **All tests passing** (unit, integration, E2E)
284
- - ✅ **Documentation updated** (API ref, guides, changelog)
285
-
286
- ### Can Transfer
287
-
288
- - ✅ **P2 tasks** (important but not critical)
289
- - ✅ **P3 tasks** (nice-to-have)
290
-
291
- ### Cannot Transfer
292
-
293
- - ❌ **P1 tasks** (critical - must complete or justify downgrade)
294
- - ❌ **Failing tests** (must fix before closing)
295
- - ❌ **Undocumented features** (must document or remove)
296
-
297
- ---
298
-
299
- ## Override with --force
300
-
301
- **Use cases** ✅:
302
- - Time-boxed sprint ended (e.g., 2-week sprint)
303
- - Business pivot (priorities changed)
304
- - External blocker (waiting on third-party)
305
-
306
- **Anti-patterns** ❌:
307
- - Avoiding difficult work
308
- - Poor planning/estimation
309
- - Impatience to start new work
310
-
311
- **Force closure**:
312
- ```bash
313
- /close-increment 001 --force
314
-
315
- ⚠️ Force closing with 3 P1 tasks incomplete
316
-
317
- This breaks the commitment. Document why:
318
- → Reason for force closure: [User enters reason]
319
-
320
- Proceeding...
321
- ```
322
-
323
- ---
324
-
325
- ## Task Status Markers
326
-
327
- | Marker | Status | Description |
328
- |--------|--------|-------------|
329
- | `[ ]` | Not started | Task planned but not begun |
330
- | `[-]` | In progress | Task currently being worked on (optional notation) |
331
- | `[x]` | Completed | Task finished successfully |
332
- | `[T]` | Transferred | Moved to another increment |
333
- | `[C]` | Canceled | No longer relevant, documented why |
334
-
335
- ---
336
-
337
- ## Related Documentation
338
-
339
- - [INCREMENT-LIFECYCLE-DESIGN.md](../../.specweave/increments/0001-core-framework/reports/INCREMENT-LIFECYCLE-DESIGN.md) - Complete lifecycle design
340
- - [CLAUDE.md](../../CLAUDE.md#increment-lifecycle-management) - Lifecycle management guide
341
-
342
- ---
343
-
344
- **Command Type**: Lifecycle management
345
- **Framework Support**: All (TypeScript, Python, Go, Rust, Java, etc.)
346
- **WIP Impact**: Frees 1 WIP slot
347
- **Output**: Closure report + transferred increment (if applicable)
@@ -1,123 +0,0 @@
1
- ---
2
- description: 🔥 Shorthand for /create-project - Initialize SpecWeave project (Alias)
3
- ---
4
-
5
- # Initialize Project (Short Alias)
6
-
7
- **⚡ Quick Alias**: This is a shorthand command for `/create-project`.
8
-
9
- Use this when you want to quickly initialize a new SpecWeave project without typing the full command name.
10
-
11
- ---
12
-
13
- ## Full Command
14
-
15
- For complete documentation, see `/create-project`.
16
-
17
- This alias provides the exact same functionality as the full command.
18
-
19
- ---
20
-
21
- ## Usage
22
-
23
- ```bash
24
- /init [project-name] [--type=<stack>]
25
- ```
26
-
27
- **Examples**:
28
- ```bash
29
- /init # Interactive prompts
30
- /init my-saas # Auto-detect tech stack
31
- /init my-api --type=python # Specify Python
32
- /init my-app --type=nextjs # Specify Next.js
33
- ```
34
-
35
- ---
36
-
37
- ## What This Does
38
-
39
- 1. **Creates directory structure**:
40
- ```
41
- my-project/
42
- ├── .specweave/
43
- │ ├── config.yaml
44
- │ ├── docs/
45
- │ ├── increments/
46
- │ └── tests/
47
- ├── .claude/
48
- │ ├── commands/
49
- │ ├── skills/ # Auto-install on demand
50
- │ └── agents/ # Auto-install on demand
51
- ├── CLAUDE.md
52
- └── README.md
53
- ```
54
-
55
- 2. **Detects tech stack** (or uses `--type` flag):
56
- - TypeScript/JavaScript → Next.js, Node.js, React
57
- - Python → FastAPI, Django, Flask
58
- - Go → Gin, Echo, standard library
59
- - .NET → ASP.NET Core
60
- - Java → Spring Boot
61
-
62
- 3. **Auto-installs components** based on your first request:
63
- ```
64
- User: "Create Next.js authentication"
65
-
66
- 📦 Installing required components...
67
- ✅ nextjs skill
68
- ✅ nodejs-backend skill
69
- ✅ security agent
70
- ✅ pm agent
71
- ```
72
-
73
- 4. **Initializes git** (if git available)
74
-
75
- 5. **Shows next steps**
76
-
77
- ---
78
-
79
- ## Tech Stack Detection
80
-
81
- **Auto-detected from**:
82
- - `package.json` (JavaScript/TypeScript)
83
- - `requirements.txt`, `pyproject.toml` (Python)
84
- - `go.mod` (Go)
85
- - `*.csproj` (.NET)
86
- - `pom.xml`, `build.gradle` (Java)
87
-
88
- **Manual specification**:
89
- ```bash
90
- /init --type=nextjs # Next.js + TypeScript
91
- /init --type=python # Python (FastAPI default)
92
- /init --type=django # Django specifically
93
- /init --type=dotnet # ASP.NET Core
94
- ```
95
-
96
- ---
97
-
98
- ## After Initialization
99
-
100
- **Start building immediately**:
101
- ```bash
102
- cd my-project
103
- /ci "User authentication" # Create first increment
104
- ```
105
-
106
- SpecWeave will:
107
- 1. Detect you need auth components
108
- 2. Auto-install: `security` agent, `nodejs-backend` skill
109
- 3. Generate specs, plan, tasks
110
- 4. Ready to implement!
111
-
112
- ---
113
-
114
- ## Other Useful Aliases
115
-
116
- - `/ci` - Create increment (shorthand for `/create-increment`)
117
- - `/si` - Start increment (shorthand for `/start-increment`)
118
- - `/vi` - Validate increment (shorthand for `/validate-increment`)
119
- - `/ls` - List increments (shorthand for `/list-increments`)
120
-
121
- ---
122
-
123
- **💡 Tip**: No need to pre-install components - they install on-demand!
@@ -1,100 +0,0 @@
1
- ---
2
- description: 🔥 Shorthand for /list-increments - List all increments (Alias)
3
- ---
4
-
5
- # List Increments (Short Alias)
6
-
7
- **⚡ Quick Alias**: This is a shorthand command for `/list-increments`.
8
-
9
- Use this when you want to quickly list increments without typing the full command name.
10
-
11
- ---
12
-
13
- ## Full Command
14
-
15
- For complete documentation, see `/list-increments`.
16
-
17
- This alias provides the exact same functionality as the full command.
18
-
19
- ---
20
-
21
- ## Usage
22
-
23
- ```bash
24
- /ls [--status=<status>] [--format=<format>]
25
- ```
26
-
27
- **Examples**:
28
- ```bash
29
- /ls # All increments
30
- /ls --status=in-progress # Only in-progress
31
- /ls --status=planned # Only planned
32
- /ls --format=detailed # Detailed view
33
- ```
34
-
35
- ---
36
-
37
- ## What This Shows
38
-
39
- **Default View** (Summary):
40
- ```
41
- 📋 SpecWeave Increments
42
-
43
- Status: in-progress (2) | planned (3) | completed (5) | closed (4)
44
-
45
- In Progress:
46
- 0012-user-authentication [████████░░] 80% (8/10 tasks)
47
- 0013-payment-integration [███░░░░░░░] 30% (3/10 tasks)
48
-
49
- Planned:
50
- 0014-admin-dashboard [░░░░░░░░░░] 0% (0/15 tasks)
51
- 0015-analytics-module [░░░░░░░░░░] 0% (0/12 tasks)
52
- ```
53
-
54
- **Detailed View** (`--format=detailed`):
55
- Shows full spec summary, architecture approach, test coverage, etc.
56
-
57
- ---
58
-
59
- ## Status Filters
60
-
61
- | Status | Description | Alias |
62
- |--------|-------------|-------|
63
- | `backlog` | Not yet planned | Ideas, proposals |
64
- | `planned` | Spec created, not started | Ready to work |
65
- | `in-progress` | Active work | Currently implementing |
66
- | `completed` | Tasks done, ready to close | Awaiting review/merge |
67
- | `closed` | Finished and archived | Done |
68
-
69
- ---
70
-
71
- ## Typical Usage
72
-
73
- **Quick check**:
74
- ```bash
75
- /ls --status=in-progress # What am I working on?
76
- ```
77
-
78
- **Planning**:
79
- ```bash
80
- /ls --status=planned # What's next?
81
- ```
82
-
83
- **Review**:
84
- ```bash
85
- /ls --format=detailed # Full increment overview
86
- ```
87
-
88
- ---
89
-
90
- ## Other Useful Aliases
91
-
92
- - `/ci` - Create increment (shorthand for `/create-increment`)
93
- - `/si` - Start increment (shorthand for `/start-increment`)
94
- - `/vi` - Validate increment (shorthand for `/validate-increment`)
95
- - `/done` - Close increment (shorthand for `/close-increment`)
96
- - `/at` - Add tasks (shorthand for `/add-tasks`)
97
-
98
- ---
99
-
100
- **💡 Tip**: Use `/ls` daily to track progress across all increments.
@@ -1,83 +0,0 @@
1
- ---
2
- description: 🔥 Shorthand for /start-increment - Start working on increment (Alias)
3
- ---
4
-
5
- # Start Increment (Short Alias)
6
-
7
- **⚡ Quick Alias**: This is a shorthand command for `/start-increment`.
8
-
9
- Use this when you want to quickly start working on an increment without typing the full command name.
10
-
11
- ---
12
-
13
- ## Full Command
14
-
15
- For complete documentation, see `/start-increment`.
16
-
17
- This alias provides the exact same functionality as the full command.
18
-
19
- ---
20
-
21
- ## Usage
22
-
23
- ```bash
24
- /si <increment-id>
25
- ```
26
-
27
- **Examples**:
28
- ```bash
29
- /si 0001
30
- /si 0042
31
- /si 0123
32
- ```
33
-
34
- ---
35
-
36
- ## What This Does
37
-
38
- 1. **Updates status** to `in-progress` in `tasks.md`
39
- 2. **Loads context** via context-manifest.yaml
40
- 3. **Creates feature branch** (if git workflow enabled)
41
- 4. **Shows increment summary**:
42
- - Spec highlights (user stories, goals)
43
- - Architecture approach
44
- - Task breakdown
45
- - Test strategy
46
-
47
- ---
48
-
49
- ## Typical Workflow
50
-
51
- ```bash
52
- # 1. Create increment
53
- /ci "User authentication"
54
-
55
- # 2. Review generated specs
56
- # ... check spec.md, plan.md, tasks.md ...
57
-
58
- # 3. Start working
59
- /si 0001
60
-
61
- # 4. Implement tasks
62
- # ... write code, tests, docs ...
63
-
64
- # 5. Validate quality
65
- /vi 0001 --quality
66
-
67
- # 6. Close when done
68
- /done 0001
69
- ```
70
-
71
- ---
72
-
73
- ## Other Useful Aliases
74
-
75
- - `/ci` - Create increment (shorthand for `/create-increment`)
76
- - `/vi` - Validate increment (shorthand for `/validate-increment`)
77
- - `/done` - Close increment (shorthand for `/close-increment`)
78
- - `/ls` - List increments (shorthand for `/list-increments`)
79
- - `/at` - Add tasks (shorthand for `/add-tasks`)
80
-
81
- ---
82
-
83
- **💡 Tip**: Always validate (`/vi`) before starting to catch spec issues early.