claude-flow-novice 2.11.0 → 2.13.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/commands/README.md +177 -129
- package/.claude/skills/cfn-changelog-management/SKILL.md +349 -0
- package/.claude/skills/cfn-changelog-management/add-changelog-entry.sh +200 -0
- package/claude-assets/commands/cfn/README.md +177 -129
- package/claude-assets/commands/cfn/cfn-loop-cli.md +268 -0
- package/claude-assets/commands/cfn/cfn-loop-document.md +20 -1
- package/claude-assets/commands/cfn/cfn-loop-frontend.md +17 -2
- package/claude-assets/commands/cfn/cfn-loop-task.md +442 -0
- package/claude-assets/commands/cfn/context-curate.md +27 -38
- package/claude-assets/commands/cfn/context-inject.md +14 -25
- package/claude-assets/commands/cfn/context-query.md +40 -45
- package/claude-assets/commands/cfn/context-reflect.md +40 -38
- package/claude-assets/commands/cfn/context-stats.md +13 -38
- package/claude-assets/commands/cfn/launch-web-dashboard.md +0 -295
- package/claude-assets/commands/cfn/list-agents-rebuild.md +18 -18
- package/claude-assets/commands/cfn/write-plan.md +246 -75
- package/claude-assets/skills/cfn-changelog-management/SKILL.md +349 -0
- package/claude-assets/skills/cfn-changelog-management/add-changelog-entry.sh +200 -0
- package/package.json +2 -1
- package/claude-assets/commands/cfn/auto-compact.md +0 -80
- package/claude-assets/commands/cfn/cfn-loop-epic.md +0 -478
- package/claude-assets/commands/cfn/cfn-loop-single.md +0 -256
- package/claude-assets/commands/cfn/cfn-loop-sprints.md +0 -396
- package/claude-assets/commands/cfn/cfn-loop.md +0 -518
- package/claude-assets/commands/cfn/claude-md.md +0 -64
- package/claude-assets/commands/cfn/claude-soul.md +0 -22
- package/claude-assets/commands/cfn/cost-savings-off.md +0 -35
- package/claude-assets/commands/cfn/cost-savings-on.md +0 -35
- package/claude-assets/commands/cfn/cost-savings-status.md +0 -34
- package/claude-assets/commands/cfn/custom-routing-activate.md +0 -55
- package/claude-assets/commands/cfn/custom-routing-deactivate.md +0 -46
- package/claude-assets/commands/cfn/dependency-recommendations.md +0 -171
- package/claude-assets/commands/cfn/fullstack.md +0 -179
- package/claude-assets/commands/cfn/github.md +0 -221
- package/claude-assets/commands/cfn/hooks.md +0 -38
- package/claude-assets/commands/cfn/metrics-summary.md +0 -58
- package/claude-assets/commands/cfn/neural.md +0 -39
- package/claude-assets/commands/cfn/parse-epic.md +0 -357
- package/claude-assets/commands/cfn/performance.md +0 -41
- package/claude-assets/commands/cfn/sparc.md +0 -46
- package/claude-assets/commands/cfn/suggest-improvements.md +0 -95
- package/claude-assets/commands/cfn/suggest-templates.md +0 -147
- package/claude-assets/commands/cfn/swarm.md +0 -24
|
@@ -1,104 +1,275 @@
|
|
|
1
|
-
|
|
1
|
+
---
|
|
2
|
+
description: "CFN Loop pre-planning: Generate structured implementation plans with TDD approach"
|
|
3
|
+
argument-hint: "<task description> [--mode=mvp|standard|enterprise]"
|
|
4
|
+
allowed-tools: ["Task", "TodoWrite", "Read", "Write", "Bash"]
|
|
5
|
+
---
|
|
2
6
|
|
|
3
|
-
|
|
4
|
-
The `write-plan` command helps create structured, test-driven implementation plans for claude-flow-novice projects, leveraging our CFN Loop workflow and adaptive context strategies.
|
|
7
|
+
# Write Plan - CFN Loop Pre-Planning
|
|
5
8
|
|
|
6
|
-
|
|
9
|
+
Generate structured implementation plan BEFORE executing CFN Loop. Outputs plan document for review.
|
|
7
10
|
|
|
8
|
-
|
|
9
|
-
- Always start with failure scenarios (Red phase)
|
|
10
|
-
- Implement minimal code to pass tests (Green phase)
|
|
11
|
-
- Refactor for quality and maintainability (Refactor phase)
|
|
11
|
+
🎯 **Use this BEFORE /cfn-loop-cli or /cfn-loop-task**
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
Utilize the CFN Loop workflow for complex implementations:
|
|
15
|
-
- **Loop 3 (Implementation)**: Create detailed implementation plan
|
|
16
|
-
- **Loop 2 (Validation)**: Comprehensive test and review
|
|
17
|
-
- **Product Owner Decision**: Strategic go/no-go checkpoint
|
|
13
|
+
**Task**: $ARGUMENTS
|
|
18
14
|
|
|
19
|
-
##
|
|
15
|
+
## What This Does
|
|
20
16
|
|
|
17
|
+
**Pre-planning phase for CFN Loop:**
|
|
18
|
+
1. Analyzes task complexity
|
|
19
|
+
2. Selects appropriate agents
|
|
20
|
+
3. Defines test cases and success criteria
|
|
21
|
+
4. Creates implementation roadmap
|
|
22
|
+
5. Outputs plan document for approval
|
|
23
|
+
|
|
24
|
+
**Then run:**
|
|
25
|
+
```bash
|
|
26
|
+
# After reviewing plan
|
|
27
|
+
/cfn-loop-cli "Implement JWT authentication" --mode=standard
|
|
28
|
+
# OR
|
|
29
|
+
/cfn-loop-task "Implement JWT authentication" --mode=standard
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Command Options
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
# Standard planning
|
|
36
|
+
/write-plan "Implement JWT authentication"
|
|
37
|
+
|
|
38
|
+
# MVP planning (faster, simpler)
|
|
39
|
+
/write-plan "Build prototype feature" --mode=mvp
|
|
40
|
+
|
|
41
|
+
# Enterprise planning (comprehensive)
|
|
42
|
+
/write-plan "Production security system" --mode=enterprise
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
**Options:**
|
|
46
|
+
- `--mode=<mvp|standard|enterprise>`: Planning depth (default: standard)
|
|
47
|
+
|
|
48
|
+
## Execution Pattern
|
|
49
|
+
|
|
50
|
+
### Step 1: Analyze Task
|
|
51
|
+
|
|
52
|
+
```javascript
|
|
53
|
+
Task("planner", `
|
|
54
|
+
ANALYZE TASK FOR CFN LOOP PLANNING
|
|
55
|
+
|
|
56
|
+
Task: $ARGUMENTS
|
|
57
|
+
Mode: ${mode}
|
|
58
|
+
|
|
59
|
+
ANALYSIS REQUIRED:
|
|
60
|
+
1. Complexity Assessment:
|
|
61
|
+
- Estimated files: 1-2 (simple) | 3-5 (standard) | >5 (complex)
|
|
62
|
+
- Estimated LOC: <200 (simple) | 200-500 (standard) | >500 (complex)
|
|
63
|
+
- Keywords: security, performance, frontend, mobile, etc.
|
|
64
|
+
|
|
65
|
+
2. Agent Selection:
|
|
66
|
+
- Loop 3 (Implementation): Based on task type
|
|
67
|
+
* Backend: backend-dev, researcher, devops
|
|
68
|
+
* Full-stack: backend-dev, react-frontend-engineer, devops
|
|
69
|
+
* Mobile: mobile-dev, backend-dev
|
|
70
|
+
* Security: security-specialist, backend-dev
|
|
71
|
+
- Loop 2 (Validation): Scale by complexity
|
|
72
|
+
* Simple: reviewer, tester
|
|
73
|
+
* Standard: +architect, +security-specialist
|
|
74
|
+
* Complex: +code-analyzer, +performance-benchmarker
|
|
75
|
+
|
|
76
|
+
3. Test Cases (TDD Approach):
|
|
77
|
+
- Red Phase: Failure scenarios
|
|
78
|
+
- Green Phase: Minimal passing implementation
|
|
79
|
+
- Refactor Phase: Quality improvements
|
|
80
|
+
|
|
81
|
+
4. Success Criteria:
|
|
82
|
+
- Test coverage target (≥80%)
|
|
83
|
+
- Performance benchmarks (if applicable)
|
|
84
|
+
- Security requirements (if applicable)
|
|
85
|
+
- Deliverables list
|
|
86
|
+
|
|
87
|
+
OUTPUT: planning/PLAN_${sanitize($ARGUMENTS)}.md
|
|
88
|
+
`)
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Step 2: Generate Plan Document
|
|
92
|
+
|
|
93
|
+
**Plan Structure:**
|
|
21
94
|
```markdown
|
|
22
|
-
# [
|
|
95
|
+
# Implementation Plan: [Task Name]
|
|
23
96
|
|
|
24
|
-
##
|
|
25
|
-
-
|
|
26
|
-
-
|
|
97
|
+
## Task Analysis
|
|
98
|
+
- **Complexity**: Simple | Standard | Complex
|
|
99
|
+
- **Estimated Files**: N
|
|
100
|
+
- **Estimated LOC**: N
|
|
101
|
+
- **Mode**: ${mode}
|
|
27
102
|
|
|
28
|
-
##
|
|
29
|
-
- Epic Context
|
|
30
|
-
- Sprint Context
|
|
31
|
-
- Specific Deliverables
|
|
103
|
+
## Agent Configuration
|
|
32
104
|
|
|
33
|
-
|
|
34
|
-
-
|
|
35
|
-
-
|
|
36
|
-
-
|
|
105
|
+
### Loop 3 (Implementation)
|
|
106
|
+
- agent-1 (role)
|
|
107
|
+
- agent-2 (role)
|
|
108
|
+
- agent-3 (role)
|
|
37
109
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
-
|
|
41
|
-
-
|
|
110
|
+
### Loop 2 (Validation)
|
|
111
|
+
- reviewer (code review)
|
|
112
|
+
- tester (quality assurance)
|
|
113
|
+
[+ architect, security-specialist for standard/enterprise]
|
|
42
114
|
|
|
43
|
-
###
|
|
44
|
-
-
|
|
45
|
-
- Edge cases
|
|
46
|
-
- Performance expectations
|
|
115
|
+
### Product Owner
|
|
116
|
+
- product-owner (PROCEED/ITERATE/ABORT decision)
|
|
47
117
|
|
|
48
|
-
##
|
|
49
|
-
|
|
118
|
+
## Test-Driven Development Plan
|
|
119
|
+
|
|
120
|
+
### Phase 1: Red (Failure Scenarios)
|
|
121
|
+
**Deliverables:**
|
|
122
|
+
- [ ] Test script: tests/test-[feature].sh
|
|
123
|
+
- [ ] Failure test cases defined
|
|
124
|
+
|
|
125
|
+
**Test Cases:**
|
|
126
|
+
1. [Test case 1 - expected failure]
|
|
127
|
+
2. [Test case 2 - edge case]
|
|
128
|
+
3. [Test case 3 - performance requirement]
|
|
129
|
+
|
|
130
|
+
### Phase 2: Green (Minimal Implementation)
|
|
131
|
+
**Deliverables:**
|
|
50
132
|
- [ ] Minimal working implementation
|
|
51
|
-
- [ ]
|
|
133
|
+
- [ ] All test cases passing
|
|
52
134
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
135
|
+
**Implementation Steps:**
|
|
136
|
+
1. [Core functionality]
|
|
137
|
+
2. [Basic validation]
|
|
138
|
+
3. [Minimal error handling]
|
|
139
|
+
|
|
140
|
+
### Phase 3: Refactor (Quality Improvement)
|
|
141
|
+
**Deliverables:**
|
|
142
|
+
- [ ] Code quality improvements
|
|
143
|
+
- [ ] Enhanced test coverage (≥80%)
|
|
144
|
+
- [ ] Documentation
|
|
58
145
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
146
|
+
**Refactoring Goals:**
|
|
147
|
+
1. [Code organization]
|
|
148
|
+
2. [Performance optimization]
|
|
149
|
+
3. [Security hardening]
|
|
63
150
|
|
|
64
151
|
## Success Criteria
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
-
|
|
152
|
+
|
|
153
|
+
### Quality Gates
|
|
154
|
+
- Loop 3 Gate: ≥${mode === 'enterprise' ? 0.85 : mode === 'standard' ? 0.75 : 0.70}
|
|
155
|
+
- Loop 2 Consensus: ≥${mode === 'enterprise' ? 0.95 : mode === 'standard' ? 0.90 : 0.80}
|
|
156
|
+
|
|
157
|
+
### Deliverables
|
|
158
|
+
- [ ] All test cases passing
|
|
159
|
+
- [ ] Test coverage ≥80%
|
|
160
|
+
- [ ] Code complexity <15 per function
|
|
161
|
+
- [ ] Security review complete
|
|
162
|
+
- [ ] Documentation updated
|
|
163
|
+
|
|
164
|
+
### Performance Benchmarks (if applicable)
|
|
165
|
+
- [Benchmark 1]
|
|
166
|
+
- [Benchmark 2]
|
|
68
167
|
|
|
69
168
|
## Potential Blockers
|
|
70
|
-
|
|
71
|
-
|
|
169
|
+
|
|
170
|
+
**Technical:**
|
|
171
|
+
- [Potential blocker 1]
|
|
172
|
+
- [Mitigation strategy]
|
|
173
|
+
|
|
174
|
+
**Dependencies:**
|
|
175
|
+
- [External dependency 1]
|
|
176
|
+
- [Fallback plan]
|
|
72
177
|
|
|
73
178
|
## Iteration Strategy
|
|
74
|
-
-
|
|
75
|
-
- Confidence threshold:
|
|
76
|
-
- Adaptive agent spawning
|
|
179
|
+
- Max iterations: ${mode === 'enterprise' ? 15 : mode === 'standard' ? 10 : 5}
|
|
180
|
+
- Confidence threshold: ${mode === 'enterprise' ? 0.95 : mode === 'standard' ? 0.90 : 0.80}
|
|
181
|
+
- Adaptive agent spawning: YES
|
|
182
|
+
|
|
183
|
+
## Next Steps
|
|
184
|
+
|
|
185
|
+
1. Review this plan
|
|
186
|
+
2. Execute CFN Loop:
|
|
187
|
+
\`\`\`bash
|
|
188
|
+
/cfn-loop-cli "$ARGUMENTS" --mode=${mode}
|
|
189
|
+
# OR for debugging:
|
|
190
|
+
/cfn-loop-task "$ARGUMENTS" --mode=${mode}
|
|
191
|
+
\`\`\`
|
|
77
192
|
```
|
|
78
193
|
|
|
79
|
-
|
|
194
|
+
### Step 3: Output Plan
|
|
195
|
+
|
|
196
|
+
```javascript
|
|
197
|
+
const planPath = `planning/PLAN_${sanitize($ARGUMENTS)}.md`;
|
|
198
|
+
Write(planPath, planContent);
|
|
199
|
+
|
|
200
|
+
console.log(`✅ Implementation plan generated: ${planPath}`);
|
|
201
|
+
console.log('');
|
|
202
|
+
console.log('📋 Plan Summary:');
|
|
203
|
+
console.log(`- Complexity: ${complexity}`);
|
|
204
|
+
console.log(`- Loop 3 Agents: ${loop3Agents.length}`);
|
|
205
|
+
console.log(`- Loop 2 Validators: ${loop2Agents.length}`);
|
|
206
|
+
console.log(`- Test Cases: ${testCases.length}`);
|
|
207
|
+
console.log(`- Success Criteria: ${successCriteria.length}`);
|
|
208
|
+
console.log('');
|
|
209
|
+
console.log('Next: Review plan, then execute CFN Loop');
|
|
210
|
+
console.log(`/cfn-loop-cli "$ARGUMENTS" --mode=${mode}`);
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
## Integration with CFN Loop
|
|
214
|
+
|
|
215
|
+
**Workflow:**
|
|
216
|
+
```
|
|
217
|
+
1. /write-plan "Task description" --mode=standard
|
|
218
|
+
↓ Generates planning/PLAN_task.md
|
|
219
|
+
|
|
220
|
+
2. Human reviews plan (optional)
|
|
221
|
+
↓ Approve or request changes
|
|
222
|
+
|
|
223
|
+
3. /cfn-loop-cli "Task description" --mode=standard
|
|
224
|
+
↓ Executes implementation following plan
|
|
225
|
+
|
|
226
|
+
4. CFN Loop autonomously implements following TDD phases
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
## Mode Comparison
|
|
230
|
+
|
|
231
|
+
| Mode | Complexity | Agents | Test Coverage | Use Case |
|
|
232
|
+
|------|------------|--------|---------------|----------|
|
|
233
|
+
| MVP | Low | 3-4 total | ≥70% | Prototypes, proof-of-concept |
|
|
234
|
+
| Standard | Medium | 5-7 total | ≥80% | Production features |
|
|
235
|
+
| Enterprise | High | 8-10 total | ≥90% | Critical systems, compliance |
|
|
236
|
+
|
|
237
|
+
## Example Output
|
|
80
238
|
|
|
81
|
-
### Spawning Plan Creation
|
|
82
|
-
```bash
|
|
83
|
-
/write-plan "Implement JWT Authentication" \
|
|
84
|
-
--epic-context '{"goal":"Secure API access"}' \
|
|
85
|
-
--sprint-context '{"sprint":"Authentication MVP"}' \
|
|
86
|
-
--agents "backend-dev,security-specialist"
|
|
87
239
|
```
|
|
240
|
+
Analyzing task...
|
|
88
241
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
242
|
+
✅ Implementation plan generated: planning/PLAN_jwt_authentication.md
|
|
243
|
+
|
|
244
|
+
📋 Plan Summary:
|
|
245
|
+
- Complexity: Standard
|
|
246
|
+
- Loop 3 Agents: 3 (backend-dev, researcher, devops)
|
|
247
|
+
- Loop 2 Validators: 4 (reviewer, tester, architect, security-specialist)
|
|
248
|
+
- Test Cases: 8
|
|
249
|
+
- Success Criteria: 6
|
|
250
|
+
|
|
251
|
+
Next: Review plan, then execute CFN Loop
|
|
252
|
+
/cfn-loop-cli "Implement JWT authentication" --mode=standard
|
|
253
|
+
```
|
|
94
254
|
|
|
95
255
|
## Best Practices
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
-
|
|
99
|
-
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
-
|
|
256
|
+
|
|
257
|
+
**When to Use:**
|
|
258
|
+
- ✅ Complex tasks (>3 steps)
|
|
259
|
+
- ✅ Security-critical features
|
|
260
|
+
- ✅ Team collaboration (plan review needed)
|
|
261
|
+
- ✅ Learning CFN Loop workflow
|
|
262
|
+
|
|
263
|
+
**When to Skip:**
|
|
264
|
+
- Simple bug fixes (go straight to /cfn-loop-cli)
|
|
265
|
+
- Urgent hotfixes (no time for planning)
|
|
266
|
+
- Well-understood patterns (agent knows what to do)
|
|
267
|
+
|
|
268
|
+
## Related Commands
|
|
269
|
+
|
|
270
|
+
- **Execute Plan**: `/cfn-loop-cli` (production) or `/cfn-loop-task` (debugging)
|
|
271
|
+
- **Document Results**: `/cfn-loop-document` (after completion)
|
|
272
|
+
|
|
273
|
+
---
|
|
274
|
+
|
|
275
|
+
**Version:** 2.0.0 (2025-10-31) - Integrated with CFN Loop v3 architecture
|
|
@@ -0,0 +1,349 @@
|
|
|
1
|
+
---
|
|
2
|
+
skill_id: cfn-changelog-management
|
|
3
|
+
name: CFN Changelog Management
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
category: documentation
|
|
6
|
+
tags: [changelog, versioning, release-notes, sparse-logging]
|
|
7
|
+
dependencies: []
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# CFN Changelog Management Skill
|
|
11
|
+
|
|
12
|
+
## Purpose
|
|
13
|
+
Systematically track implementation changes with sparse, structured entries appended to project changelog. Enables quick visibility into what changed, when, and why without verbose commit-style messages.
|
|
14
|
+
|
|
15
|
+
## Problem Solved
|
|
16
|
+
Traditional changelogs require manual curation and often become stale or inconsistent. Agents completing features, fixing bugs, or making architectural changes need a lightweight way to document impact without context-switching to git commits or detailed documentation.
|
|
17
|
+
|
|
18
|
+
## When to Use
|
|
19
|
+
|
|
20
|
+
### ✅ REQUIRED Usage Scenarios
|
|
21
|
+
- **After feature implementation** - Agent completes feature work
|
|
22
|
+
- **After bug fix** - Agent resolves issue with code changes
|
|
23
|
+
- **After breaking change** - API/interface modifications that affect consumers
|
|
24
|
+
- **After dependency update** - Major version bumps or security patches
|
|
25
|
+
- **After architectural change** - Coordination pattern modifications, skill refactors
|
|
26
|
+
|
|
27
|
+
### ⚠️ OPTIONAL Usage Scenarios
|
|
28
|
+
- **After performance optimization** - Measurable improvements (>10% speedup)
|
|
29
|
+
- **After security enhancement** - Hardening, vulnerability fixes
|
|
30
|
+
- **Internal refactoring** - Code cleanup without behavioral changes (use judgment)
|
|
31
|
+
|
|
32
|
+
### ❌ DO NOT USE For
|
|
33
|
+
- **Routine maintenance** - Formatting, linting, comment updates
|
|
34
|
+
- **Work-in-progress** - Incomplete features or experimental changes
|
|
35
|
+
- **Test-only changes** - Adding tests without production code changes
|
|
36
|
+
- **Documentation-only updates** - README edits, comment clarifications
|
|
37
|
+
|
|
38
|
+
## Interface
|
|
39
|
+
|
|
40
|
+
### Primary Script: `add-changelog-entry.sh`
|
|
41
|
+
|
|
42
|
+
**Required Parameters:**
|
|
43
|
+
- `--type`: Entry type (feature|bugfix|breaking|dependency|architecture|performance|security)
|
|
44
|
+
- `--summary`: One-line description (10-100 chars)
|
|
45
|
+
- `--impact`: What changed and why it matters
|
|
46
|
+
|
|
47
|
+
**Optional Parameters:**
|
|
48
|
+
- `--version`: Target version (default: auto-increment patch)
|
|
49
|
+
- `--issue`: Related issue/bug number (e.g., "BUG-123", "#456")
|
|
50
|
+
- `--files`: Key files affected (comma-separated, max 5)
|
|
51
|
+
- `--migration`: Migration notes for breaking changes
|
|
52
|
+
|
|
53
|
+
**Usage:**
|
|
54
|
+
```bash
|
|
55
|
+
./.claude/skills/cfn-changelog-management/add-changelog-entry.sh \
|
|
56
|
+
--type "feature" \
|
|
57
|
+
--summary "Add backlog management skill for deferred work tracking" \
|
|
58
|
+
--impact "Agents can now systematically capture deferred items with structured metadata instead of losing context in chat history" \
|
|
59
|
+
--files ".claude/skills/cfn-backlog-management/SKILL.md,readme/BACKLOG.md"
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Output Location
|
|
63
|
+
All entries appended to: `readme/CHANGELOG.md`
|
|
64
|
+
|
|
65
|
+
## Changelog File Structure
|
|
66
|
+
|
|
67
|
+
```markdown
|
|
68
|
+
# Claude Flow Novice Changelog
|
|
69
|
+
|
|
70
|
+
## [Unreleased]
|
|
71
|
+
|
|
72
|
+
### Features
|
|
73
|
+
- Add backlog management skill (2025-10-31)
|
|
74
|
+
- Impact: Systematic deferred work tracking with priority/tag organization
|
|
75
|
+
- Files: `.claude/skills/cfn-backlog-management/`
|
|
76
|
+
|
|
77
|
+
### Bug Fixes
|
|
78
|
+
|
|
79
|
+
### Breaking Changes
|
|
80
|
+
|
|
81
|
+
### Dependencies
|
|
82
|
+
|
|
83
|
+
### Architecture
|
|
84
|
+
|
|
85
|
+
### Performance
|
|
86
|
+
|
|
87
|
+
### Security
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## [2.11.0] - 2025-10-31
|
|
92
|
+
|
|
93
|
+
### Features
|
|
94
|
+
- Backlog management skill implementation
|
|
95
|
+
- Impact: Centralized tracking of deferred work items
|
|
96
|
+
- Files: `.claude/skills/cfn-backlog-management/add-backlog-item.sh`
|
|
97
|
+
|
|
98
|
+
...
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## Entry Types
|
|
102
|
+
|
|
103
|
+
### Feature
|
|
104
|
+
New functionality, skills, commands, or capabilities.
|
|
105
|
+
```bash
|
|
106
|
+
--type "feature"
|
|
107
|
+
--summary "Implement Redis pub/sub coordination for zero-token waiting"
|
|
108
|
+
--impact "Agents block on BLPOP instead of polling, eliminating API calls during wait cycles"
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
### Bug Fix
|
|
112
|
+
Defect resolution, error handling improvements.
|
|
113
|
+
```bash
|
|
114
|
+
--type "bugfix"
|
|
115
|
+
--summary "Fix race condition in Loop 3 confidence collection"
|
|
116
|
+
--impact "Orchestrator now uses synchronous temp file capture instead of polling Redis keys"
|
|
117
|
+
--issue "BUG-10"
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### Breaking Change
|
|
121
|
+
Incompatible changes requiring user/agent migration.
|
|
122
|
+
```bash
|
|
123
|
+
--type "breaking"
|
|
124
|
+
--summary "Rename skill cfn-redis-coordination → cfn-swarm-coordination"
|
|
125
|
+
--impact "All agent spawn commands must update skill references"
|
|
126
|
+
--migration "Run: sed -i 's/cfn-redis-coordination/cfn-swarm-coordination/g' .claude/agents/**/*.md"
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### Dependency
|
|
130
|
+
Package updates, version bumps, security patches.
|
|
131
|
+
```bash
|
|
132
|
+
--type "dependency"
|
|
133
|
+
--summary "Upgrade redis 5.0.0 → 5.8.3"
|
|
134
|
+
--impact "Fixes CVE-2024-1234, adds BLPOP timeout parameter support"
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Architecture
|
|
138
|
+
Coordination pattern changes, skill refactors, system design updates.
|
|
139
|
+
```bash
|
|
140
|
+
--type "architecture"
|
|
141
|
+
--summary "Extract output processing into dedicated skill"
|
|
142
|
+
--impact "95% code reuse between Loop 3 and Loop 2 consensus collection"
|
|
143
|
+
--files ".claude/skills/cfn-agent-output-processing/SKILL.md"
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Performance
|
|
147
|
+
Optimizations with measurable impact.
|
|
148
|
+
```bash
|
|
149
|
+
--type "performance"
|
|
150
|
+
--summary "Parallel agent spawning with background processes"
|
|
151
|
+
--impact "3x speedup for 3-agent coordination (sequential: 15s → parallel: 5s max latency)"
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### Security
|
|
155
|
+
Hardening, vulnerability fixes, audit improvements.
|
|
156
|
+
```bash
|
|
157
|
+
--type "security"
|
|
158
|
+
--summary "Add pre-edit backup hook for safe file revert"
|
|
159
|
+
--impact "Prevents git conflicts in parallel sessions, 24h backup retention"
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
## Validation Rules
|
|
163
|
+
|
|
164
|
+
1. **Type validation**: Must be one of 7 defined types
|
|
165
|
+
2. **Summary length**: 10-100 characters (enforces brevity)
|
|
166
|
+
3. **Impact required**: Cannot be empty (enforces "why it matters")
|
|
167
|
+
4. **File limit**: Max 5 files (prevents noise)
|
|
168
|
+
5. **Version format**: Semantic versioning (X.Y.Z)
|
|
169
|
+
|
|
170
|
+
## Sparse Language Guidelines
|
|
171
|
+
|
|
172
|
+
### ✅ Good Examples
|
|
173
|
+
```
|
|
174
|
+
Summary: "Add Redis coordination skill"
|
|
175
|
+
Impact: "Zero-token agent waiting via BLPOP"
|
|
176
|
+
|
|
177
|
+
Summary: "Fix confidence parsing edge case"
|
|
178
|
+
Impact: "Handles percentage format (85%) in addition to decimal (0.85)"
|
|
179
|
+
|
|
180
|
+
Summary: "Upgrade better-sqlite3 to v12.4.1"
|
|
181
|
+
Impact: "Node 22 compatibility, fixes installation errors on WSL2"
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### ❌ Bad Examples (Too Verbose)
|
|
185
|
+
```
|
|
186
|
+
Summary: "We have implemented a comprehensive Redis-based coordination system..."
|
|
187
|
+
Impact: "This change allows agents to coordinate more efficiently by using a blocking..."
|
|
188
|
+
|
|
189
|
+
Summary: "Fixed a bug"
|
|
190
|
+
Impact: "There was an issue that has been resolved"
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
### Sparse Pattern Rules
|
|
194
|
+
- **Active voice**: "Add feature" not "Feature added"
|
|
195
|
+
- **No articles**: "Fix bug" not "Fix the bug"
|
|
196
|
+
- **No fluff**: "Enables X" not "This change enables X"
|
|
197
|
+
- **Measurable impact**: Include numbers when relevant (3x speedup, 95% reduction)
|
|
198
|
+
|
|
199
|
+
## Integration Examples
|
|
200
|
+
|
|
201
|
+
### Loop 3 Agent (After Feature Implementation)
|
|
202
|
+
```bash
|
|
203
|
+
# Agent completes feature work
|
|
204
|
+
Edit: file_path="src/new-feature.ts" ...
|
|
205
|
+
|
|
206
|
+
# Document change
|
|
207
|
+
./.claude/skills/cfn-changelog-management/add-changelog-entry.sh \
|
|
208
|
+
--type "feature" \
|
|
209
|
+
--summary "JWT authentication middleware" \
|
|
210
|
+
--impact "Stateless auth reduces session storage by 80%" \
|
|
211
|
+
--files "src/middleware/auth.ts,src/types/jwt.ts"
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
### Loop 2 Validator (After Identifying Bug Fix)
|
|
215
|
+
```bash
|
|
216
|
+
# Validator reviews fix
|
|
217
|
+
./.claude/skills/cfn-changelog-management/add-changelog-entry.sh \
|
|
218
|
+
--type "bugfix" \
|
|
219
|
+
--summary "Prevent null pointer in Redis connection retry" \
|
|
220
|
+
--impact "Eliminates crashes during Redis unavailability" \
|
|
221
|
+
--issue "BUG-42" \
|
|
222
|
+
--files "src/redis/client.ts"
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### Product Owner (After Architectural Decision)
|
|
226
|
+
```bash
|
|
227
|
+
# Product Owner approves design change
|
|
228
|
+
./.claude/skills/cfn-changelog-management/add-changelog-entry.sh \
|
|
229
|
+
--type "architecture" \
|
|
230
|
+
--summary "Split orchestrator into modular helper scripts" \
|
|
231
|
+
--impact "78% code reduction, improved testability" \
|
|
232
|
+
--files ".claude/skills/cfn-loop-orchestration/helpers/"
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
## Versioning Strategy
|
|
236
|
+
|
|
237
|
+
### Auto-Increment (Default)
|
|
238
|
+
Script reads current version from `package.json`, increments patch:
|
|
239
|
+
- Current: `2.11.0` → Entry added to: `[Unreleased]`
|
|
240
|
+
- On release: Move `[Unreleased]` → `[2.11.1] - YYYY-MM-DD`
|
|
241
|
+
|
|
242
|
+
### Manual Version (Override)
|
|
243
|
+
```bash
|
|
244
|
+
--version "3.0.0" # Specify major/minor bump explicitly
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
### Release Workflow
|
|
248
|
+
1. Agents add entries to `[Unreleased]` section
|
|
249
|
+
2. On release trigger (manual or automated):
|
|
250
|
+
- Rename `[Unreleased]` → `[X.Y.Z] - DATE`
|
|
251
|
+
- Create new empty `[Unreleased]` section
|
|
252
|
+
- Update `package.json` version
|
|
253
|
+
|
|
254
|
+
## Query Interface
|
|
255
|
+
|
|
256
|
+
**Filter by type:**
|
|
257
|
+
```bash
|
|
258
|
+
sed -n '/### Features/,/### Bug Fixes/p' readme/CHANGELOG.md
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
**Recent entries (last 10):**
|
|
262
|
+
```bash
|
|
263
|
+
grep -A 2 "^- " readme/CHANGELOG.md | head -30
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
**Search by keyword:**
|
|
267
|
+
```bash
|
|
268
|
+
grep -i "redis" readme/CHANGELOG.md
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
**Entries for specific version:**
|
|
272
|
+
```bash
|
|
273
|
+
sed -n '/## \[2.11.0\]/,/## \[2.10.0\]/p' readme/CHANGELOG.md
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
## Best Practices
|
|
277
|
+
|
|
278
|
+
1. **Immediate logging**: Add entry immediately after completing work, not batched
|
|
279
|
+
2. **User perspective**: Describe impact from user/agent consumer viewpoint
|
|
280
|
+
3. **File references**: Include key files for context (not exhaustive list)
|
|
281
|
+
4. **Link issues**: Reference bug numbers or GitHub issues when applicable
|
|
282
|
+
5. **Migration notes**: Always include for breaking changes
|
|
283
|
+
|
|
284
|
+
## Anti-Patterns
|
|
285
|
+
|
|
286
|
+
❌ **Verbose commit messages**: "This commit implements a new feature that..."
|
|
287
|
+
❌ **Generic summaries**: "Fixed bugs", "Updated code", "Improvements"
|
|
288
|
+
❌ **Missing impact**: "Added function X" (Why does it matter?)
|
|
289
|
+
❌ **Duplicate entries**: Check existing changelog before adding
|
|
290
|
+
❌ **Version conflicts**: Don't manually edit version, use --version flag
|
|
291
|
+
|
|
292
|
+
## Example Entry Lifecycle
|
|
293
|
+
|
|
294
|
+
**Step 1: Agent completes feature**
|
|
295
|
+
```bash
|
|
296
|
+
add-changelog-entry.sh \
|
|
297
|
+
--type "feature" \
|
|
298
|
+
--summary "Multi-pattern confidence parsing" \
|
|
299
|
+
--impact "100% extraction success, supports explicit/percentage/qualitative formats"
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
**Result in CHANGELOG.md:**
|
|
303
|
+
```markdown
|
|
304
|
+
## [Unreleased]
|
|
305
|
+
|
|
306
|
+
### Features
|
|
307
|
+
- Multi-pattern confidence parsing (2025-10-31)
|
|
308
|
+
- Impact: 100% extraction success, supports explicit/percentage/qualitative formats
|
|
309
|
+
- Files: `.claude/skills/cfn-agent-output-processing/parse-confidence.sh`
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
**Step 2: Release triggered**
|
|
313
|
+
```bash
|
|
314
|
+
# Manual or automated
|
|
315
|
+
npm version minor # 2.11.0 → 2.12.0
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
**Result:**
|
|
319
|
+
```markdown
|
|
320
|
+
## [2.12.0] - 2025-11-01
|
|
321
|
+
|
|
322
|
+
### Features
|
|
323
|
+
- Multi-pattern confidence parsing (2025-10-31)
|
|
324
|
+
- Impact: 100% extraction success, supports explicit/percentage/qualitative formats
|
|
325
|
+
- Files: `.claude/skills/cfn-agent-output-processing/parse-confidence.sh`
|
|
326
|
+
|
|
327
|
+
---
|
|
328
|
+
|
|
329
|
+
## [Unreleased]
|
|
330
|
+
|
|
331
|
+
### Features
|
|
332
|
+
|
|
333
|
+
### Bug Fixes
|
|
334
|
+
...
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
## Success Metrics
|
|
338
|
+
|
|
339
|
+
- **Entry quality**: ≥90% of entries include measurable impact
|
|
340
|
+
- **Sparse language**: Average summary length ≤60 characters
|
|
341
|
+
- **Timeliness**: ≥80% of entries added within same sprint as implementation
|
|
342
|
+
- **Coverage**: 100% of features/breaking changes documented
|
|
343
|
+
- **Queryability**: Users can find relevant changes in <30 seconds
|
|
344
|
+
|
|
345
|
+
## References
|
|
346
|
+
|
|
347
|
+
- **Sparse Language**: readme/CLAUDE.md - Documentation Guidelines
|
|
348
|
+
- **Backlog Management**: `.claude/skills/cfn-backlog-management/SKILL.md`
|
|
349
|
+
- **Versioning**: `package.json` - Single source of truth
|