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,157 +1,205 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CFN Loop Commands - Quick Reference
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Workflows vs Skills vs Playbooks - When to Use What
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
### Skills (Most Common) - Building Blocks
|
|
6
|
+
**What:** Single-purpose bash scripts in `.claude/skills/`
|
|
7
|
+
**When:** Most tasks - they're the building blocks
|
|
8
|
+
**Example:** `cfn-redis-coordination`, `cfn-agent-spawning`, `cfn-loop-validation`
|
|
6
9
|
|
|
7
|
-
## 📋 Features
|
|
8
|
-
|
|
9
|
-
### ✅ **Simple Slash Command**
|
|
10
10
|
```bash
|
|
11
|
-
|
|
12
|
-
/
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
/claude-md --no-backup # Skip backup creation
|
|
11
|
+
# Direct skill invocation
|
|
12
|
+
./.claude/skills/cfn-redis-coordination/invoke-waiting-mode.sh enter \
|
|
13
|
+
--task-id "task-123" \
|
|
14
|
+
--agent-id "coder-1"
|
|
16
15
|
```
|
|
17
16
|
|
|
18
|
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
17
|
+
**Use skills when:**
|
|
18
|
+
- Single, focused operation needed
|
|
19
|
+
- Called by agents or coordinators
|
|
20
|
+
- Part of larger workflow
|
|
21
|
+
- Reusable across different tasks
|
|
22
|
+
|
|
23
|
+
### Playbooks (Not Currently Used) - Pre-Configured Sequences
|
|
24
|
+
**What:** JSON files defining skill sequences for common patterns
|
|
25
|
+
**When:** Repeating the same skill sequence often
|
|
26
|
+
**Status:** Not implemented yet, use skills directly
|
|
27
|
+
|
|
28
|
+
### Workflows - Complex Automation
|
|
29
|
+
**What:** Event-driven, multi-step automation with conditions/branching
|
|
30
|
+
**When:** Complex sequences with conditional logic
|
|
31
|
+
**Example:** CI/CD pipelines, feature development workflows
|
|
32
|
+
|
|
33
|
+
```yaml
|
|
34
|
+
name: "feature-development"
|
|
35
|
+
trigger: "branch-created"
|
|
36
|
+
steps:
|
|
37
|
+
- name: "analyze"
|
|
38
|
+
agent: "researcher"
|
|
39
|
+
|
|
40
|
+
- name: "implement"
|
|
41
|
+
agent: "backend-dev"
|
|
42
|
+
depends: ["analyze"]
|
|
43
|
+
parallel: true # Multiple agents in parallel
|
|
44
|
+
|
|
45
|
+
- name: "test"
|
|
46
|
+
agent: "tester"
|
|
47
|
+
depends: ["implement"]
|
|
48
|
+
condition: "if tests_exist" # Conditional execution
|
|
49
|
+
```
|
|
22
50
|
|
|
23
|
-
|
|
51
|
+
**Use workflows when:**
|
|
52
|
+
- Event-driven automation (git hooks, CI/CD)
|
|
53
|
+
- Conditional branching logic needed
|
|
54
|
+
- Multi-agent parallel execution
|
|
55
|
+
- Long-running background processes
|
|
56
|
+
- Integration with external systems
|
|
24
57
|
|
|
25
|
-
|
|
26
|
-
1. User runs `/claude-md`
|
|
27
|
-
2. System detects project type
|
|
28
|
-
3. Generates appropriate CLAUDE.md
|
|
29
|
-
4. Creates backup if file exists
|
|
58
|
+
## Decision Tree
|
|
30
59
|
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
60
|
+
```
|
|
61
|
+
Need to automate something?
|
|
62
|
+
├─ Single operation?
|
|
63
|
+
│ └─ Use SKILL directly
|
|
64
|
+
├─ Complex logic (conditionals, events, parallel)?
|
|
65
|
+
│ └─ Create WORKFLOW (YAML via /workflow)
|
|
66
|
+
└─ CFN Loop execution?
|
|
67
|
+
├─ Planning first? → /write-plan then /cfn-loop-cli
|
|
68
|
+
├─ Production? → /cfn-loop-cli
|
|
69
|
+
├─ Debugging? → /cfn-loop-task
|
|
70
|
+
└─ Frontend? → /cfn-loop-frontend
|
|
71
|
+
```
|
|
37
72
|
|
|
38
|
-
##
|
|
73
|
+
## Examples
|
|
39
74
|
|
|
40
|
-
###
|
|
41
|
-
|
|
42
|
-
- `register-claude-md.js` - Slash command registration
|
|
43
|
-
- `../npx/claude-md-protection.js` - NPX protection logic
|
|
44
|
-
- `../../scripts/post-install-claude-md.js` - Post-install hook
|
|
75
|
+
### Example 1: Simple Task (Use Skill)
|
|
76
|
+
**Goal:** Enter waiting mode for agent
|
|
45
77
|
|
|
46
|
-
|
|
47
|
-
-
|
|
48
|
-
-
|
|
49
|
-
|
|
50
|
-
- **Package.json**: `postinstall` script triggers protection
|
|
78
|
+
```bash
|
|
79
|
+
./.claude/skills/cfn-redis-coordination/invoke-waiting-mode.sh enter \
|
|
80
|
+
--task-id "task-123" --agent-id "coder-1"
|
|
81
|
+
```
|
|
51
82
|
|
|
52
|
-
|
|
83
|
+
### Example 2: CFN Loop Execution
|
|
84
|
+
**Goal:** Implement JWT authentication
|
|
53
85
|
|
|
54
|
-
|
|
86
|
+
**Option 1: Plan First (Recommended for Complex Tasks)**
|
|
55
87
|
```bash
|
|
56
|
-
#
|
|
57
|
-
/
|
|
88
|
+
# Step 1: Generate plan
|
|
89
|
+
/write-plan "Implement JWT authentication" --mode=standard
|
|
90
|
+
# Reviews: planning/PLAN_jwt_authentication.md
|
|
58
91
|
|
|
59
|
-
#
|
|
60
|
-
|
|
61
|
-
# ✅ CLAUDE.md generated successfully
|
|
92
|
+
# Step 2: Execute
|
|
93
|
+
/cfn-loop-cli "Implement JWT authentication" --mode=standard
|
|
62
94
|
```
|
|
63
95
|
|
|
64
|
-
|
|
96
|
+
**Option 2: Direct Execution (Simple Tasks)**
|
|
65
97
|
```bash
|
|
66
|
-
#
|
|
67
|
-
/
|
|
68
|
-
|
|
69
|
-
#
|
|
70
|
-
|
|
71
|
-
# ══════════════════════════════════════════════════
|
|
72
|
-
# # Claude Code Configuration - JavaScript Project
|
|
73
|
-
# ...
|
|
74
|
-
# ══════════════════════════════════════════════════
|
|
75
|
-
# 📊 Total length: 2,847 characters
|
|
98
|
+
# Production execution (cost-optimized)
|
|
99
|
+
/cfn-loop-cli "Implement JWT authentication" --mode=standard
|
|
100
|
+
|
|
101
|
+
# OR debugging (full visibility)
|
|
102
|
+
/cfn-loop-task "Implement JWT authentication" --mode=standard
|
|
76
103
|
```
|
|
77
104
|
|
|
78
|
-
###
|
|
105
|
+
### Example 3: Complex Automation (Use Workflow)
|
|
106
|
+
**Goal:** Full feature development (analyze → implement → test → deploy)
|
|
107
|
+
|
|
79
108
|
```bash
|
|
80
|
-
#
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
# Output:
|
|
84
|
-
# 🛡️ NPX Protection Activated
|
|
85
|
-
# 📄 Generated: claude-copy-to-main.md
|
|
86
|
-
# 💡 Your existing CLAUDE.md is protected from overwrite
|
|
87
|
-
# 🔄 Review and merge changes manually as needed
|
|
88
|
-
```
|
|
109
|
+
# Create workflow (via /workflow)
|
|
110
|
+
/workflow create feature-pipeline
|
|
89
111
|
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
### **Project Type Detection:**
|
|
93
|
-
- Analyzes `package.json`, file patterns, and directory structure
|
|
94
|
-
- Detects frameworks (React, Express, Django, etc.)
|
|
95
|
-
- Suggests appropriate CLAUDE.md configurations
|
|
96
|
-
|
|
97
|
-
### **Confidence Levels:**
|
|
98
|
-
- **High (>70%)**: Automatic generation recommended
|
|
99
|
-
- **Medium (30-70%)**: Generate with user confirmation
|
|
100
|
-
- **Low (<30%)**: Manual review suggested
|
|
101
|
-
|
|
102
|
-
## 🔧 Configuration
|
|
103
|
-
|
|
104
|
-
### **Generation Preferences:**
|
|
105
|
-
`.claude-flow-novice/preferences/generation.json`:
|
|
106
|
-
```json
|
|
107
|
-
{
|
|
108
|
-
"autoGenerate": true,
|
|
109
|
-
"includeFrameworkSpecific": true,
|
|
110
|
-
"includeBestPractices": true,
|
|
111
|
-
"backupExisting": true,
|
|
112
|
-
"confidenceThreshold": 0.3
|
|
113
|
-
}
|
|
112
|
+
# Execute workflow
|
|
113
|
+
/workflow execute feature-pipeline
|
|
114
114
|
```
|
|
115
115
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
-
|
|
131
|
-
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
-
|
|
139
|
-
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
-
|
|
151
|
-
-
|
|
152
|
-
-
|
|
153
|
-
|
|
116
|
+
## Quick Reference Table
|
|
117
|
+
|
|
118
|
+
| Type | Files | Complexity | Conditional Logic | Parallel Execution | Event-Driven |
|
|
119
|
+
|------|-------|------------|-------------------|-------------------|--------------|
|
|
120
|
+
| **Skill** | `.sh` scripts | Low | No | No | No |
|
|
121
|
+
| **CFN Loop** | Slash commands | Medium | Yes (built-in) | Yes (agents) | No |
|
|
122
|
+
| **Workflow** | `.yaml` definitions | High | Yes | Yes | Yes |
|
|
123
|
+
|
|
124
|
+
---
|
|
125
|
+
|
|
126
|
+
## CFN Loop Commands (Current)
|
|
127
|
+
|
|
128
|
+
### Execution Commands
|
|
129
|
+
- `/cfn-loop-task` - Task mode (debugging, full visibility, Main Chat coordinates)
|
|
130
|
+
- `/cfn-loop-cli` - CLI mode (production, cost-optimized, coordinator spawns CLI agents)
|
|
131
|
+
- `/cfn-loop-frontend` - Visual iteration (screenshot + video validation, supports both modes)
|
|
132
|
+
|
|
133
|
+
### Planning & Documentation
|
|
134
|
+
- `/write-plan` - Pre-planning phase (generates TDD implementation plan)
|
|
135
|
+
- `/cfn-loop-document` - Documentation generation (updates `/readme`)
|
|
136
|
+
|
|
137
|
+
### Configuration
|
|
138
|
+
- `/cfn-mode` - Toggle CLI vs Task spawning mode
|
|
139
|
+
- `/cfn-optimize-agents` - Agent optimization settings
|
|
140
|
+
- `/cfn-claude-sync` - Sync rules from CLAUDE.md to commands
|
|
141
|
+
|
|
142
|
+
### Infrastructure
|
|
143
|
+
- `/switch-api` - Switch between Z.ai and Anthropic providers
|
|
144
|
+
|
|
145
|
+
### Automation
|
|
146
|
+
- `/workflow` - Event-driven workflow automation (complex multi-step)
|
|
147
|
+
|
|
148
|
+
### Testing & Utilities
|
|
149
|
+
- `/hello-world-tests` - CFN coordination validation tests (4 layers)
|
|
150
|
+
- `/github-commit` - Git commit with CI/CD monitoring
|
|
151
|
+
- `/launch-web-dashboard` - Start web portal (http://localhost:3000)
|
|
152
|
+
- `/list-agents-rebuild` - Regenerate agent list from discovery
|
|
153
|
+
|
|
154
|
+
### Adaptive Context (ACE System)
|
|
155
|
+
- `/context-stats` - View adaptive context statistics
|
|
156
|
+
- `/context-reflect` - Extract lessons from task execution
|
|
157
|
+
- `/context-query` - Query context bullets by category/tags
|
|
158
|
+
- `/context-inject` - Inject context into CLAUDE.md dynamically
|
|
159
|
+
- `/context-curate` - Merge reflection deltas with deduplication
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## When to Use Each Command
|
|
164
|
+
|
|
165
|
+
### /write-plan (Pre-Planning)
|
|
166
|
+
**Use before complex CFN Loop tasks:**
|
|
167
|
+
- Security-critical features
|
|
168
|
+
- Complex architecture decisions
|
|
169
|
+
- Team collaboration (plan review)
|
|
170
|
+
- Learning CFN Loop workflow
|
|
171
|
+
|
|
172
|
+
### /cfn-loop-cli (Production)
|
|
173
|
+
**Use for:**
|
|
174
|
+
- Production features
|
|
175
|
+
- Long-running tasks (>10 min)
|
|
176
|
+
- Multi-iteration workflows
|
|
177
|
+
- Cost-sensitive projects
|
|
178
|
+
- **Cost:** $0.054/iteration with Z.ai routing
|
|
179
|
+
|
|
180
|
+
### /cfn-loop-task (Debugging)
|
|
181
|
+
**Use for:**
|
|
182
|
+
- Debugging CFN Loop issues
|
|
183
|
+
- Learning agent interactions
|
|
184
|
+
- Prototyping configurations
|
|
185
|
+
- Short tasks (<5 min)
|
|
186
|
+
- **Cost:** $0.150/iteration (3x CLI, but full visibility)
|
|
187
|
+
|
|
188
|
+
### /cfn-loop-frontend (Visual Iteration)
|
|
189
|
+
**Use for:**
|
|
190
|
+
- React/Vue/Angular components
|
|
191
|
+
- UI implementation with mockups
|
|
192
|
+
- Accessibility validation
|
|
193
|
+
- Visual regression testing
|
|
194
|
+
- **Supports:** Both CLI and Task modes
|
|
195
|
+
|
|
196
|
+
### /workflow (Complex Automation)
|
|
197
|
+
**Use for:**
|
|
198
|
+
- CI/CD pipelines
|
|
199
|
+
- Event-driven automation
|
|
200
|
+
- Multi-step with conditionals
|
|
201
|
+
- External system integration
|
|
154
202
|
|
|
155
203
|
---
|
|
156
204
|
|
|
157
|
-
**
|
|
205
|
+
**Version:** 3.0.0 (2025-10-31) - Consolidated command structure with workflows/skills guide
|
|
@@ -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
|