agentic-forge 0.0.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/.gitattributes +24 -0
- package/.github/workflows/ci.yml +70 -0
- package/.markdownlint-cli2.jsonc +16 -0
- package/.prettierignore +3 -0
- package/.prettierrc +6 -0
- package/.vscode/agentic-forge.code-workspace +26 -0
- package/CHANGELOG.md +100 -0
- package/CLAUDE.md +158 -0
- package/CONTRIBUTING.md +152 -0
- package/LICENSE +21 -0
- package/README.md +145 -0
- package/agentic-forge-banner.png +0 -0
- package/biome.json +21 -0
- package/package.json +5 -0
- package/scripts/copy-assets.js +21 -0
- package/src/agents/explorer.md +97 -0
- package/src/agents/reviewer.md +137 -0
- package/src/checkpoints/manager.ts +119 -0
- package/src/claude/.claude/skills/analyze/SKILL.md +241 -0
- package/src/claude/.claude/skills/analyze/references/bug.md +62 -0
- package/src/claude/.claude/skills/analyze/references/debt.md +76 -0
- package/src/claude/.claude/skills/analyze/references/doc.md +67 -0
- package/src/claude/.claude/skills/analyze/references/security.md +76 -0
- package/src/claude/.claude/skills/analyze/references/style.md +72 -0
- package/src/claude/.claude/skills/create-checkpoint/SKILL.md +88 -0
- package/src/claude/.claude/skills/create-log/SKILL.md +75 -0
- package/src/claude/.claude/skills/fix-analyze/SKILL.md +102 -0
- package/src/claude/.claude/skills/git-branch/SKILL.md +71 -0
- package/src/claude/.claude/skills/git-commit/SKILL.md +107 -0
- package/src/claude/.claude/skills/git-pr/SKILL.md +96 -0
- package/src/claude/.claude/skills/orchestrate/SKILL.md +120 -0
- package/src/claude/.claude/skills/sdlc-plan/SKILL.md +163 -0
- package/src/claude/.claude/skills/sdlc-plan/references/bug.md +115 -0
- package/src/claude/.claude/skills/sdlc-plan/references/chore.md +105 -0
- package/src/claude/.claude/skills/sdlc-plan/references/feature.md +130 -0
- package/src/claude/.claude/skills/sdlc-review/SKILL.md +215 -0
- package/src/claude/.claude/skills/workflow-builder/SKILL.md +185 -0
- package/src/claude/.claude/skills/workflow-builder/references/REFERENCE.md +487 -0
- package/src/claude/.claude/skills/workflow-builder/references/workflow-example.yaml +427 -0
- package/src/cli.ts +182 -0
- package/src/commands/config-cmd.ts +28 -0
- package/src/commands/index.ts +21 -0
- package/src/commands/init.ts +96 -0
- package/src/commands/release-notes.ts +85 -0
- package/src/commands/resume.ts +103 -0
- package/src/commands/run.ts +234 -0
- package/src/commands/shortcuts.ts +11 -0
- package/src/commands/skills-dir.ts +11 -0
- package/src/commands/status.ts +112 -0
- package/src/commands/update.ts +64 -0
- package/src/commands/version.ts +27 -0
- package/src/commands/workflows.ts +129 -0
- package/src/config.ts +129 -0
- package/src/console.ts +790 -0
- package/src/executor.ts +354 -0
- package/src/git/worktree.ts +236 -0
- package/src/logging/logger.ts +95 -0
- package/src/orchestrator.ts +815 -0
- package/src/parser.ts +225 -0
- package/src/progress.ts +306 -0
- package/src/prompts/agentic-system.md +31 -0
- package/src/ralph-loop.ts +260 -0
- package/src/renderer.ts +164 -0
- package/src/runner.ts +634 -0
- package/src/signal-manager.ts +55 -0
- package/src/steps/base.ts +71 -0
- package/src/steps/conditional-step.ts +144 -0
- package/src/steps/index.ts +15 -0
- package/src/steps/parallel-step.ts +213 -0
- package/src/steps/prompt-step.ts +121 -0
- package/src/steps/ralph-loop-step.ts +186 -0
- package/src/steps/serial-step.ts +84 -0
- package/src/templates/analysis/bug.md.j2 +35 -0
- package/src/templates/analysis/debt.md.j2 +38 -0
- package/src/templates/analysis/doc.md.j2 +45 -0
- package/src/templates/analysis/security.md.j2 +35 -0
- package/src/templates/analysis/style.md.j2 +44 -0
- package/src/templates/analysis-summary.md.j2 +58 -0
- package/src/templates/checkpoint.md.j2 +27 -0
- package/src/templates/implementation-report.md.j2 +81 -0
- package/src/templates/memory.md.j2 +16 -0
- package/src/templates/plan-bug.md.j2 +42 -0
- package/src/templates/plan-chore.md.j2 +27 -0
- package/src/templates/plan-feature.md.j2 +41 -0
- package/src/templates/progress.json.j2 +16 -0
- package/src/templates/ralph-report.md.j2 +45 -0
- package/src/types.ts +141 -0
- package/src/workflows/analyze-codebase-merge.yaml +328 -0
- package/src/workflows/analyze-codebase.yaml +196 -0
- package/src/workflows/analyze-single.yaml +56 -0
- package/src/workflows/demo.yaml +180 -0
- package/src/workflows/one-shot.yaml +54 -0
- package/src/workflows/plan-build-review.yaml +160 -0
- package/src/workflows/ralph-loop.yaml +73 -0
- package/tests/config.test.ts +219 -0
- package/tests/console.test.ts +506 -0
- package/tests/executor.test.ts +339 -0
- package/tests/init.test.ts +86 -0
- package/tests/logger.test.ts +110 -0
- package/tests/parser.test.ts +290 -0
- package/tests/progress.test.ts +345 -0
- package/tests/ralph-loop.test.ts +418 -0
- package/tests/renderer.test.ts +350 -0
- package/tests/runner.test.ts +497 -0
- package/tests/setup.test.ts +7 -0
- package/tests/signal-manager.test.ts +26 -0
- package/tests/steps.test.ts +412 -0
- package/tests/worktree.test.ts +411 -0
- package/tsconfig.json +18 -0
- package/vitest.config.ts +8 -0
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: af-sdlc-plan
|
|
3
|
+
description: Create an implementation plan for a task
|
|
4
|
+
argument-hint: <workflow-id> [type] [output_dir] [explore_agents] <context>
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# SDLC Plan
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
Create a structured implementation plan for the given task. This skill analyzes the codebase, identifies relevant files and patterns, and produces a detailed plan with milestones and actionable tasks. Supports different plan types (feature, bug, chore) with type-specific guidance.
|
|
12
|
+
|
|
13
|
+
## Arguments
|
|
14
|
+
|
|
15
|
+
### Definitions
|
|
16
|
+
|
|
17
|
+
- **`<workflow-id>`** (required): The workflow identifier for output organization.
|
|
18
|
+
- **`[type]`** (optional): Plan type. Values: `feature`, `bug`, `chore`, `auto`. Defaults to `auto`.
|
|
19
|
+
- **`[output_dir]`** (optional): Directory to write plan.md file (default to `agentic/outputs/<workflow-id>`).
|
|
20
|
+
- **`[explore_agents]`** (optional): Number of explore agents for codebase analysis. Defaults to `0`.
|
|
21
|
+
- **`<context>`** (required): Task description or issue reference.
|
|
22
|
+
|
|
23
|
+
### Values
|
|
24
|
+
|
|
25
|
+
\$ARGUMENTS
|
|
26
|
+
|
|
27
|
+
## Additional Resources
|
|
28
|
+
|
|
29
|
+
Load ONE of these based on the `[type]` argument (or detected type if auto):
|
|
30
|
+
|
|
31
|
+
- For feature plans, see [references/feature.md](references/feature.md)
|
|
32
|
+
- For bug fix plans, see [references/bug.md](references/bug.md)
|
|
33
|
+
- For chore plans, see [references/chore.md](references/chore.md)
|
|
34
|
+
|
|
35
|
+
## Core Principles
|
|
36
|
+
|
|
37
|
+
### Plan Structure
|
|
38
|
+
|
|
39
|
+
- **Every plan must use Milestones and Tasks** - This applies to all plan types (feature, bug, chore). Having a single milestone is valid for smaller work items.
|
|
40
|
+
- Tasks should be specific enough to execute without ambiguity
|
|
41
|
+
- Include file paths with line numbers where changes are needed
|
|
42
|
+
- Consider testing requirements in each milestone
|
|
43
|
+
- Flag any unclear requirements or assumptions
|
|
44
|
+
- Plans are static documentation - never modified during implementation
|
|
45
|
+
- Always include a Progress section as the first `##` header with two subsections: Implementation (milestones/tasks) and Validation (verification and tests)
|
|
46
|
+
|
|
47
|
+
### Milestone Design
|
|
48
|
+
|
|
49
|
+
- Each milestone should deliver visible progress
|
|
50
|
+
- Milestones should be testable independently
|
|
51
|
+
- Order milestones by dependency (foundational work first)
|
|
52
|
+
|
|
53
|
+
### Milestone Scoping (Critical)
|
|
54
|
+
|
|
55
|
+
- **Each milestone must be scoped to a single Claude session** - If a milestone is too large for one session, split it into multiple milestones.
|
|
56
|
+
- **Milestones are executed in fresh sessions** - When building the plan, assume each milestone will be executed in a new session that only has access to the plan document. All necessary context must be included in the plan itself.
|
|
57
|
+
- **Every milestone must produce a concrete output** - Examples: generate code, update documentation, update plan, create tests. A milestone should never be purely research without output, because subsequent sessions cannot access that research.
|
|
58
|
+
- **Research milestones require documented outputs** - If research is needed, the milestone must output its findings (e.g., "Research X and update Milestone 2 checklist with findings"). However, this pattern is discouraged. Prefer milestones that produce direct project artifacts.
|
|
59
|
+
- **Ideal milestones are scoped units of work** - Each milestone should generate output in the current project that represents tangible progression toward the plan's goal.
|
|
60
|
+
|
|
61
|
+
### Milestone & Task Template
|
|
62
|
+
|
|
63
|
+
All plans must use this common structure for Progress and Milestones sections:
|
|
64
|
+
|
|
65
|
+
```markdown
|
|
66
|
+
## Progress
|
|
67
|
+
|
|
68
|
+
### Implementation
|
|
69
|
+
|
|
70
|
+
- [ ] Milestone 1: {{milestone_title}}
|
|
71
|
+
- [ ] Task 1.1: {{task_title}}
|
|
72
|
+
- [ ] Task 1.2: {{task_title}}
|
|
73
|
+
- [ ] Milestone 2: {{milestone_title}}
|
|
74
|
+
- [ ] Task 2.1: {{task_title}}
|
|
75
|
+
|
|
76
|
+
### Validation
|
|
77
|
+
|
|
78
|
+
- [ ] {{validation_item}}
|
|
79
|
+
|
|
80
|
+
## Milestones
|
|
81
|
+
|
|
82
|
+
### Milestone {{milestone_number}}: {{milestone_title}}
|
|
83
|
+
|
|
84
|
+
{{milestone_description}}
|
|
85
|
+
|
|
86
|
+
#### Task {{milestone_number}}.{{task_number}}: {{task_title}}
|
|
87
|
+
|
|
88
|
+
{{task_description}}
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
<!--
|
|
92
|
+
Common placeholders (used by all plan types):
|
|
93
|
+
- {{milestone_number}}: Sequential number (1, 2, 3, ...)
|
|
94
|
+
- {{milestone_title}}: What this milestone accomplishes
|
|
95
|
+
- {{milestone_description}}: Brief description of the milestone
|
|
96
|
+
- {{task_number}}: Task number within milestone (1, 2, 3, ...)
|
|
97
|
+
- {{task_title}}: Clear, actionable task title
|
|
98
|
+
- {{task_description}}: Specific task details with acceptance criteria
|
|
99
|
+
- {{validation_item}}: Validation criterion or test item
|
|
100
|
+
-->
|
|
101
|
+
|
|
102
|
+
## Instructions
|
|
103
|
+
|
|
104
|
+
1. **Parse Arguments**
|
|
105
|
+
- Extract workflow-id, type, output_dir, explore_agents, and context from arguments
|
|
106
|
+
- Default type to `auto` if not specified
|
|
107
|
+
- Default explore_agents to `0` if not specified
|
|
108
|
+
|
|
109
|
+
2. **Detect Plan Type** (if type=auto)
|
|
110
|
+
- Analyze the context to determine type:
|
|
111
|
+
- **feature**: New functionality, enhancements, additions
|
|
112
|
+
- **bug**: Error fixes, unexpected behavior corrections, defects
|
|
113
|
+
- **chore**: Refactoring, dependency updates, maintenance, cleanup
|
|
114
|
+
- Once detected, proceed with that type
|
|
115
|
+
|
|
116
|
+
3. **Load Type-Specific Guidelines**
|
|
117
|
+
Based on the detected or specified type, load the corresponding reference file:
|
|
118
|
+
- `feature` -> Read [references/feature.md](references/feature.md)
|
|
119
|
+
- `bug` -> Read [references/bug.md](references/bug.md)
|
|
120
|
+
- `chore` -> Read [references/chore.md](references/chore.md)
|
|
121
|
+
|
|
122
|
+
4. **Analyze Codebase**
|
|
123
|
+
- If `explore_agents` is 0: Perform a quick codebase exploration in the main session using Glob, Grep, and Read tools
|
|
124
|
+
- If `explore_agents` is 1+: Launch that many explorer agents (Task tool with subagent_type=Explore) for in-depth parallel analysis
|
|
125
|
+
- Identify files and components relevant to the task
|
|
126
|
+
- Understand existing patterns and conventions
|
|
127
|
+
- Map dependencies and impact areas
|
|
128
|
+
|
|
129
|
+
5. **Generate Plan**
|
|
130
|
+
- Apply type-specific planning approach from the loaded reference
|
|
131
|
+
- Create discrete, independent milestones
|
|
132
|
+
- Include specific file paths and line numbers
|
|
133
|
+
- Estimate complexity (low, medium, high)
|
|
134
|
+
|
|
135
|
+
6. **Write Output**
|
|
136
|
+
- Write plan document as .md format to the output_dir.
|
|
137
|
+
- Return JSON summary
|
|
138
|
+
|
|
139
|
+
## Output Guidance
|
|
140
|
+
|
|
141
|
+
Return JSON with metadata only. The full plan content is saved to the markdown file.
|
|
142
|
+
|
|
143
|
+
```json
|
|
144
|
+
{
|
|
145
|
+
"success": true,
|
|
146
|
+
"plan_type": "{{type}}",
|
|
147
|
+
"summary": "{{summary}}",
|
|
148
|
+
"milestone_count": "{{milestone_count}}",
|
|
149
|
+
"task_count": "{{task_count}}",
|
|
150
|
+
"complexity": "{{complexity}}",
|
|
151
|
+
"document_path": "{{document_path}}"
|
|
152
|
+
}
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
<!--
|
|
156
|
+
Placeholders:
|
|
157
|
+
- {{type}}: Plan type (feature, bug, chore)
|
|
158
|
+
- {{summary}}: Brief one-line summary of the plan
|
|
159
|
+
- {{milestone_count}}: Total number of milestones
|
|
160
|
+
- {{task_count}}: Total number of tasks across all milestones
|
|
161
|
+
- {{complexity}}: Overall complexity (low, medium, high)
|
|
162
|
+
- {{document_path}}: Path to generated plan.md file
|
|
163
|
+
-->
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
# Bug Fix Plan Reference
|
|
2
|
+
|
|
3
|
+
## Planning Approach
|
|
4
|
+
|
|
5
|
+
Bug fix plans focus on thorough root cause analysis and prevention of regression. Understanding the cause is critical to implementing an effective fix.
|
|
6
|
+
|
|
7
|
+
## Key Sections
|
|
8
|
+
|
|
9
|
+
A bug fix plan should include:
|
|
10
|
+
|
|
11
|
+
1. **Description**: Clear explanation of the bug and its impact
|
|
12
|
+
2. **Reproduction Steps**: Step-by-step instructions to reproduce the bug
|
|
13
|
+
3. **Root Cause Analysis**: Technical explanation of why the bug occurs
|
|
14
|
+
4. **Fix Strategy**: High-level approach to fixing the bug
|
|
15
|
+
5. **Tasks**: Specific implementation tasks
|
|
16
|
+
6. **Validation**: Steps to verify the fix works
|
|
17
|
+
7. **Testing**: Test cases to prevent regression
|
|
18
|
+
|
|
19
|
+
## Investigation Focus
|
|
20
|
+
|
|
21
|
+
When analyzing a bug:
|
|
22
|
+
|
|
23
|
+
- Trace the execution path that leads to the bug
|
|
24
|
+
- Identify the specific conditions that trigger it
|
|
25
|
+
- Look for related code paths that may have similar issues
|
|
26
|
+
- Check if there are existing tests that should have caught this
|
|
27
|
+
- Understand the impact scope (which users/features are affected)
|
|
28
|
+
|
|
29
|
+
## Root Cause Categories
|
|
30
|
+
|
|
31
|
+
Common root causes to investigate:
|
|
32
|
+
|
|
33
|
+
- **Logic Errors**: Incorrect conditions, off-by-one errors, wrong operators
|
|
34
|
+
- **State Management**: Race conditions, stale data, incorrect state transitions
|
|
35
|
+
- **Error Handling**: Unhandled exceptions, silent failures, missing edge cases
|
|
36
|
+
- **Integration Issues**: API contract violations, data format mismatches
|
|
37
|
+
- **Configuration**: Environment-specific issues, missing settings
|
|
38
|
+
- **Resource Management**: Memory leaks, connection exhaustion, deadlocks
|
|
39
|
+
|
|
40
|
+
## Fix Strategy Guidelines
|
|
41
|
+
|
|
42
|
+
- Address the root cause, not just symptoms
|
|
43
|
+
- Consider defensive measures to prevent similar bugs
|
|
44
|
+
- Avoid fixes that introduce new complexity
|
|
45
|
+
- Prefer targeted changes over broad refactoring
|
|
46
|
+
- Include test coverage for the specific failure case
|
|
47
|
+
|
|
48
|
+
## Milestone Patterns
|
|
49
|
+
|
|
50
|
+
Typically 1-3 milestones per bug fix. Common patterns:
|
|
51
|
+
|
|
52
|
+
1. **Investigation & Setup**: Reproduce bug, identify root cause, document findings
|
|
53
|
+
2. **Implementation**: Apply fix, handle edge cases
|
|
54
|
+
3. **Validation & Testing**: Verify fix, add regression tests
|
|
55
|
+
|
|
56
|
+
## Template
|
|
57
|
+
|
|
58
|
+
```markdown
|
|
59
|
+
# Bug Fix: {{bug_title}}
|
|
60
|
+
|
|
61
|
+
## Progress
|
|
62
|
+
|
|
63
|
+
### Implementation
|
|
64
|
+
|
|
65
|
+
{{implementation_checklist}}
|
|
66
|
+
|
|
67
|
+
### Validation
|
|
68
|
+
|
|
69
|
+
{{validation_checklist}}
|
|
70
|
+
|
|
71
|
+
## Description
|
|
72
|
+
|
|
73
|
+
{{description}}
|
|
74
|
+
|
|
75
|
+
## Reproduction Steps
|
|
76
|
+
|
|
77
|
+
{{reproduction_steps}}
|
|
78
|
+
|
|
79
|
+
## Root Cause Analysis
|
|
80
|
+
|
|
81
|
+
{{root_cause}}
|
|
82
|
+
|
|
83
|
+
## Fix Strategy
|
|
84
|
+
|
|
85
|
+
{{fix_strategy}}
|
|
86
|
+
|
|
87
|
+
## Milestones
|
|
88
|
+
|
|
89
|
+
### Milestone {{milestone_number}}: {{milestone_title}}
|
|
90
|
+
|
|
91
|
+
{{milestone_description}}
|
|
92
|
+
|
|
93
|
+
#### Task {{milestone_number}}.{{task_number}}: {{task_title}}
|
|
94
|
+
|
|
95
|
+
{{task_description}}
|
|
96
|
+
|
|
97
|
+
## Validation
|
|
98
|
+
|
|
99
|
+
{{validation}}
|
|
100
|
+
|
|
101
|
+
## Testing
|
|
102
|
+
|
|
103
|
+
{{testing}}
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
<!--
|
|
107
|
+
Type-specific placeholders (see SKILL.md for common milestone/task placeholders):
|
|
108
|
+
- {{bug_title}}: Concise title for the bug (e.g., "Login Timeout on Safari OAuth Redirect")
|
|
109
|
+
- {{description}}: Clear explanation of the bug and its impact
|
|
110
|
+
- {{reproduction_steps}}: Numbered steps to reproduce the bug
|
|
111
|
+
- {{root_cause}}: Technical explanation with code references
|
|
112
|
+
- {{fix_strategy}}: High-level approach to fixing the bug
|
|
113
|
+
- {{validation}}: Steps to verify the bug is fixed
|
|
114
|
+
- {{testing}}: Test cases to add to prevent regression
|
|
115
|
+
-->
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# Chore Plan Reference
|
|
2
|
+
|
|
3
|
+
## Planning Approach
|
|
4
|
+
|
|
5
|
+
Chore plans focus on maintenance tasks that improve code quality, update dependencies, or perform housekeeping without adding new functionality. The goal is clear scope definition and methodical execution.
|
|
6
|
+
|
|
7
|
+
## Key Sections
|
|
8
|
+
|
|
9
|
+
A chore plan should include:
|
|
10
|
+
|
|
11
|
+
1. **Description**: What needs to be done and why
|
|
12
|
+
2. **Scope**: What is in scope and explicitly out of scope
|
|
13
|
+
3. **Tasks**: Specific implementation tasks in execution order
|
|
14
|
+
4. **Validation Criteria**: How to verify the chore is complete
|
|
15
|
+
|
|
16
|
+
## Common Chore Types
|
|
17
|
+
|
|
18
|
+
- **Dependency Updates**: Upgrading packages, handling breaking changes
|
|
19
|
+
- **Refactoring**: Improving code structure without changing behavior
|
|
20
|
+
- **Configuration**: Updating build configs, CI/CD pipelines, tooling
|
|
21
|
+
- **Cleanup**: Removing dead code, fixing warnings, organizing files
|
|
22
|
+
- **Documentation**: Updating outdated docs, adding missing docs
|
|
23
|
+
- **Migration**: Moving to new patterns, APIs, or technologies
|
|
24
|
+
|
|
25
|
+
## Scope Definition
|
|
26
|
+
|
|
27
|
+
Clear scope prevents scope creep:
|
|
28
|
+
|
|
29
|
+
- List specific files, directories, or components in scope
|
|
30
|
+
- Explicitly state what is NOT in scope
|
|
31
|
+
- Define boundaries for the change
|
|
32
|
+
- Note any related work that should be done separately
|
|
33
|
+
|
|
34
|
+
## Task Ordering
|
|
35
|
+
|
|
36
|
+
Order tasks for safe, incremental progress:
|
|
37
|
+
|
|
38
|
+
1. Preparation tasks (backups, feature flags, etc.)
|
|
39
|
+
2. Core changes in dependency order
|
|
40
|
+
3. Cleanup and verification tasks
|
|
41
|
+
4. Documentation updates
|
|
42
|
+
|
|
43
|
+
## Risk Mitigation
|
|
44
|
+
|
|
45
|
+
For chores that could break things:
|
|
46
|
+
|
|
47
|
+
- Identify rollback strategies
|
|
48
|
+
- Plan for incremental changes that can be tested
|
|
49
|
+
- Note any feature flags or gradual rollout needs
|
|
50
|
+
- Consider timing (avoid high-traffic periods)
|
|
51
|
+
|
|
52
|
+
## Milestone Patterns
|
|
53
|
+
|
|
54
|
+
Typically 1-2 milestones per chore. Common patterns:
|
|
55
|
+
|
|
56
|
+
1. **Implementation**: Execute the main tasks
|
|
57
|
+
2. **Verification**: Validate changes, update docs (if needed)
|
|
58
|
+
|
|
59
|
+
For larger chores, break into logical phases based on scope boundaries.
|
|
60
|
+
|
|
61
|
+
## Template
|
|
62
|
+
|
|
63
|
+
```markdown
|
|
64
|
+
# Chore: {{chore_title}}
|
|
65
|
+
|
|
66
|
+
## Progress
|
|
67
|
+
|
|
68
|
+
### Implementation
|
|
69
|
+
|
|
70
|
+
{{implementation_checklist}}
|
|
71
|
+
|
|
72
|
+
### Validation
|
|
73
|
+
|
|
74
|
+
{{validation_checklist}}
|
|
75
|
+
|
|
76
|
+
## Description
|
|
77
|
+
|
|
78
|
+
{{description}}
|
|
79
|
+
|
|
80
|
+
## Scope
|
|
81
|
+
|
|
82
|
+
{{scope}}
|
|
83
|
+
|
|
84
|
+
## Milestones
|
|
85
|
+
|
|
86
|
+
### Milestone {{milestone_number}}: {{milestone_title}}
|
|
87
|
+
|
|
88
|
+
{{milestone_description}}
|
|
89
|
+
|
|
90
|
+
#### Task {{milestone_number}}.{{task_number}}: {{task_title}}
|
|
91
|
+
|
|
92
|
+
{{task_description}}
|
|
93
|
+
|
|
94
|
+
## Validation Criteria
|
|
95
|
+
|
|
96
|
+
{{validation_criteria}}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
<!--
|
|
100
|
+
Type-specific placeholders (see SKILL.md for common milestone/task placeholders):
|
|
101
|
+
- {{chore_title}}: Concise title for the chore (e.g., "Update All Dependencies")
|
|
102
|
+
- {{description}}: Brief explanation of what needs to be done and why
|
|
103
|
+
- {{scope}}: What is in scope and out of scope (use bullet points)
|
|
104
|
+
- {{validation_criteria}}: Checklist to verify completion
|
|
105
|
+
-->
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
# Feature Plan Reference
|
|
2
|
+
|
|
3
|
+
## Planning Approach
|
|
4
|
+
|
|
5
|
+
Feature plans focus on comprehensive design with incremental delivery. Each milestone should be independently valuable and testable. Architecture decisions should align with existing codebase patterns.
|
|
6
|
+
|
|
7
|
+
## Key Sections
|
|
8
|
+
|
|
9
|
+
A feature plan should include:
|
|
10
|
+
|
|
11
|
+
1. **Overview**: What the feature does and why it's valuable
|
|
12
|
+
2. **Requirements**: Functional and non-functional requirements
|
|
13
|
+
3. **Architecture**: High-level design and patterns to use
|
|
14
|
+
4. **Milestones**: Logical breakdown with tasks
|
|
15
|
+
5. **Testing Strategy**: How the feature will be tested
|
|
16
|
+
6. **Validation Criteria**: How to verify the feature is complete
|
|
17
|
+
|
|
18
|
+
## Requirements Gathering
|
|
19
|
+
|
|
20
|
+
Capture both types of requirements:
|
|
21
|
+
|
|
22
|
+
**Functional Requirements**:
|
|
23
|
+
|
|
24
|
+
- What the feature should do
|
|
25
|
+
- User interactions and flows
|
|
26
|
+
- Input/output specifications
|
|
27
|
+
- Edge cases and error handling
|
|
28
|
+
|
|
29
|
+
**Non-Functional Requirements**:
|
|
30
|
+
|
|
31
|
+
- Performance expectations
|
|
32
|
+
- Security considerations
|
|
33
|
+
- Scalability needs
|
|
34
|
+
- Accessibility requirements
|
|
35
|
+
- Compatibility constraints
|
|
36
|
+
|
|
37
|
+
## Architecture Considerations
|
|
38
|
+
|
|
39
|
+
When designing the feature:
|
|
40
|
+
|
|
41
|
+
- Study existing patterns in the codebase
|
|
42
|
+
- Identify integration points with existing code
|
|
43
|
+
- Define data models and API contracts
|
|
44
|
+
- Consider component reusability
|
|
45
|
+
- Plan for extensibility without over-engineering
|
|
46
|
+
- Document key technical decisions
|
|
47
|
+
|
|
48
|
+
## Milestone Patterns
|
|
49
|
+
|
|
50
|
+
Typically 2-5 milestones per feature. Common patterns:
|
|
51
|
+
|
|
52
|
+
1. Core infrastructure/data models
|
|
53
|
+
2. Basic functionality (happy path)
|
|
54
|
+
3. Edge cases and error handling
|
|
55
|
+
4. Polish and optimization
|
|
56
|
+
5. Documentation and cleanup
|
|
57
|
+
|
|
58
|
+
## Task Decomposition
|
|
59
|
+
|
|
60
|
+
Within each milestone:
|
|
61
|
+
|
|
62
|
+
- Tasks should be specific and actionable
|
|
63
|
+
- Include file paths where changes are needed
|
|
64
|
+
- Consider testing tasks alongside implementation
|
|
65
|
+
- Note any dependencies between tasks
|
|
66
|
+
|
|
67
|
+
## Testing Strategy
|
|
68
|
+
|
|
69
|
+
Plan testing at multiple levels:
|
|
70
|
+
|
|
71
|
+
- **Unit Tests**: Individual functions and components
|
|
72
|
+
- **Integration Tests**: Component interactions
|
|
73
|
+
- **E2E Tests**: Full user flows
|
|
74
|
+
- **Manual Testing**: Exploratory and edge cases
|
|
75
|
+
|
|
76
|
+
## Template
|
|
77
|
+
|
|
78
|
+
```markdown
|
|
79
|
+
# Feature: {{feature_title}}
|
|
80
|
+
|
|
81
|
+
## Progress
|
|
82
|
+
|
|
83
|
+
### Implementation
|
|
84
|
+
|
|
85
|
+
{{implementation_checklist}}
|
|
86
|
+
|
|
87
|
+
### Validation
|
|
88
|
+
|
|
89
|
+
{{validation_checklist}}
|
|
90
|
+
|
|
91
|
+
## Overview
|
|
92
|
+
|
|
93
|
+
{{overview}}
|
|
94
|
+
|
|
95
|
+
## Requirements
|
|
96
|
+
|
|
97
|
+
{{requirements}}
|
|
98
|
+
|
|
99
|
+
## Architecture
|
|
100
|
+
|
|
101
|
+
{{architecture}}
|
|
102
|
+
|
|
103
|
+
## Milestones
|
|
104
|
+
|
|
105
|
+
### Milestone {{milestone_number}}: {{milestone_title}}
|
|
106
|
+
|
|
107
|
+
{{milestone_description}}
|
|
108
|
+
|
|
109
|
+
#### Task {{milestone_number}}.{{task_number}}: {{task_title}}
|
|
110
|
+
|
|
111
|
+
{{task_description}}
|
|
112
|
+
|
|
113
|
+
## Testing Strategy
|
|
114
|
+
|
|
115
|
+
{{testing_strategy}}
|
|
116
|
+
|
|
117
|
+
## Validation Criteria
|
|
118
|
+
|
|
119
|
+
{{validation_criteria}}
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
<!--
|
|
123
|
+
Type-specific placeholders (see SKILL.md for common milestone/task placeholders):
|
|
124
|
+
- {{feature_title}}: Concise title for the feature (e.g., "User Authentication with OAuth")
|
|
125
|
+
- {{overview}}: What this feature does and why it's valuable (2-4 sentences)
|
|
126
|
+
- {{requirements}}: Functional and non-functional requirements (use subsections)
|
|
127
|
+
- {{architecture}}: High-level design decisions and patterns
|
|
128
|
+
- {{testing_strategy}}: How the feature will be tested at each level
|
|
129
|
+
- {{validation_criteria}}: Checklist to verify feature completion
|
|
130
|
+
-->
|