specsmd 0.0.1
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/README.md +300 -0
- package/bin/cli.js +21 -0
- package/flows/aidlc/README.md +372 -0
- package/flows/aidlc/agents/construction-agent.md +81 -0
- package/flows/aidlc/agents/inception-agent.md +95 -0
- package/flows/aidlc/agents/master-agent.md +61 -0
- package/flows/aidlc/agents/operations-agent.md +89 -0
- package/flows/aidlc/commands/construction-agent.md +63 -0
- package/flows/aidlc/commands/inception-agent.md +55 -0
- package/flows/aidlc/commands/master-agent.md +47 -0
- package/flows/aidlc/commands/operations-agent.md +77 -0
- package/flows/aidlc/context-config.yaml +41 -0
- package/flows/aidlc/memory-bank.yaml +104 -0
- package/flows/aidlc/quick-start.md +315 -0
- package/flows/aidlc/skills/construction/bolt-list.md +163 -0
- package/flows/aidlc/skills/construction/bolt-replan.md +343 -0
- package/flows/aidlc/skills/construction/bolt-start.md +289 -0
- package/flows/aidlc/skills/construction/bolt-status.md +185 -0
- package/flows/aidlc/skills/construction/navigator.md +196 -0
- package/flows/aidlc/skills/inception/bolt-plan.md +338 -0
- package/flows/aidlc/skills/inception/context.md +171 -0
- package/flows/aidlc/skills/inception/intent-create.md +211 -0
- package/flows/aidlc/skills/inception/intent-list.md +124 -0
- package/flows/aidlc/skills/inception/navigator.md +207 -0
- package/flows/aidlc/skills/inception/requirements.md +227 -0
- package/flows/aidlc/skills/inception/review.md +248 -0
- package/flows/aidlc/skills/inception/story-create.md +304 -0
- package/flows/aidlc/skills/inception/units.md +271 -0
- package/flows/aidlc/skills/master/analyze-context.md +132 -0
- package/flows/aidlc/skills/master/answer-question.md +141 -0
- package/flows/aidlc/skills/master/explain-flow.md +146 -0
- package/flows/aidlc/skills/master/project-init.md +281 -0
- package/flows/aidlc/skills/master/route-request.md +126 -0
- package/flows/aidlc/skills/operations/build.md +237 -0
- package/flows/aidlc/skills/operations/deploy.md +259 -0
- package/flows/aidlc/skills/operations/monitor.md +265 -0
- package/flows/aidlc/skills/operations/navigator.md +209 -0
- package/flows/aidlc/skills/operations/verify.md +224 -0
- package/flows/aidlc/templates/construction/bolt-template.md +193 -0
- package/flows/aidlc/templates/construction/bolt-types/bdd-construction-bolt.md +250 -0
- package/flows/aidlc/templates/construction/bolt-types/ddd-construction-bolt/adr-template.md +49 -0
- package/flows/aidlc/templates/construction/bolt-types/ddd-construction-bolt/ddd-01-domain-model-template.md +55 -0
- package/flows/aidlc/templates/construction/bolt-types/ddd-construction-bolt/ddd-02-technical-design-template.md +67 -0
- package/flows/aidlc/templates/construction/bolt-types/ddd-construction-bolt/ddd-03-test-report-template.md +62 -0
- package/flows/aidlc/templates/construction/bolt-types/ddd-construction-bolt.md +528 -0
- package/flows/aidlc/templates/construction/bolt-types/simple-construction-bolt.md +273 -0
- package/flows/aidlc/templates/construction/bolt-types/spike-bolt.md +240 -0
- package/flows/aidlc/templates/construction/bolt-types/tdd-construction-bolt.md +259 -0
- package/flows/aidlc/templates/construction/construction-log-template.md +129 -0
- package/flows/aidlc/templates/construction/standards/coding-standards.md +29 -0
- package/flows/aidlc/templates/construction/standards/system-architecture.md +22 -0
- package/flows/aidlc/templates/construction/standards/tech-stack.md +19 -0
- package/flows/aidlc/templates/inception/inception-log-template.md +134 -0
- package/flows/aidlc/templates/inception/project/README.md +55 -0
- package/flows/aidlc/templates/inception/requirements-template.md +144 -0
- package/flows/aidlc/templates/inception/stories-template.md +38 -0
- package/flows/aidlc/templates/inception/story-template.md +147 -0
- package/flows/aidlc/templates/inception/system-context-template.md +29 -0
- package/flows/aidlc/templates/inception/unit-brief-template.md +177 -0
- package/flows/aidlc/templates/inception/units-template.md +52 -0
- package/flows/aidlc/templates/standards/catalog.yaml +345 -0
- package/flows/aidlc/templates/standards/coding-standards.guide.md +553 -0
- package/flows/aidlc/templates/standards/data-stack.guide.md +162 -0
- package/flows/aidlc/templates/standards/tech-stack.guide.md +280 -0
- package/lib/InstallerFactory.js +36 -0
- package/lib/cli-utils.js +372 -0
- package/lib/constants.js +31 -0
- package/lib/installer.js +314 -0
- package/lib/installers/AntigravityInstaller.js +22 -0
- package/lib/installers/ClaudeInstaller.js +85 -0
- package/lib/installers/ClineInstaller.js +21 -0
- package/lib/installers/CodexInstaller.js +21 -0
- package/lib/installers/CopilotInstaller.js +113 -0
- package/lib/installers/CursorInstaller.js +63 -0
- package/lib/installers/GeminiInstaller.js +75 -0
- package/lib/installers/KiroInstaller.js +22 -0
- package/lib/installers/OpenCodeInstaller.js +22 -0
- package/lib/installers/RooInstaller.js +22 -0
- package/lib/installers/ToolInstaller.js +73 -0
- package/lib/installers/WindsurfInstaller.js +76 -0
- package/lib/markdown-validator.ts +175 -0
- package/lib/yaml-validator.ts +99 -0
- package/package.json +65 -0
|
@@ -0,0 +1,259 @@
|
|
|
1
|
+
# Bolt Type: TDD Construction
|
|
2
|
+
|
|
3
|
+
## Mandatory Output Rules (READ FIRST)
|
|
4
|
+
|
|
5
|
+
- 🚫 **NEVER** use ASCII tables for options - they break at different terminal widths
|
|
6
|
+
- ✅ **ALWAYS** use numbered list format: `N - **Option**: Description`
|
|
7
|
+
- ✅ **ALWAYS** use status indicators: ✅ (done) ⏳ (current) [ ] (pending) 🚫 (blocked)
|
|
8
|
+
|
|
9
|
+
## Success Metrics
|
|
10
|
+
|
|
11
|
+
- ✅ Activities presented as numbered lists (not tables)
|
|
12
|
+
- ✅ Stage progress shown with status indicators
|
|
13
|
+
- ✅ Human checkpoints clearly marked
|
|
14
|
+
|
|
15
|
+
## Failure Modes
|
|
16
|
+
|
|
17
|
+
- ❌ Using ASCII table for activities
|
|
18
|
+
- ❌ Auto-advancing without human confirmation
|
|
19
|
+
- ❌ Skipping stages
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## Metadata
|
|
24
|
+
|
|
25
|
+
```yaml
|
|
26
|
+
bolt_type: tdd-construction-bolt
|
|
27
|
+
name: TDD Construction Bolt
|
|
28
|
+
description: Test-Driven Development with red-green-refactor cycle
|
|
29
|
+
version: 1.0.0
|
|
30
|
+
suitable_for:
|
|
31
|
+
- Algorithm implementation
|
|
32
|
+
- Utility functions
|
|
33
|
+
- Pure logic without external dependencies
|
|
34
|
+
- Libraries and reusable components
|
|
35
|
+
stages_count: 3
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## Overview
|
|
41
|
+
|
|
42
|
+
This bolt type implements Test-Driven Development (TDD) methodology through the classic red-green-refactor cycle: write failing tests, make them pass, then refactor.
|
|
43
|
+
|
|
44
|
+
**Best For**:
|
|
45
|
+
|
|
46
|
+
- Algorithm and logic implementation
|
|
47
|
+
- Utility functions and helpers
|
|
48
|
+
- Pure functions without side effects
|
|
49
|
+
- Libraries and SDKs
|
|
50
|
+
- Components with clear inputs/outputs
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Stages
|
|
55
|
+
|
|
56
|
+
### Stage 1: test-first
|
|
57
|
+
|
|
58
|
+
**Objective**: Write failing tests that specify expected behavior
|
|
59
|
+
|
|
60
|
+
**Duration**: Hours (typically 1-3 hours)
|
|
61
|
+
|
|
62
|
+
**Activities**:
|
|
63
|
+
|
|
64
|
+
1 - **Analyze requirements**: Identify test cases and edge cases
|
|
65
|
+
2 - **Write unit tests**: Create tests for core functionality (failing)
|
|
66
|
+
3 - **Write edge case tests**: Cover boundary conditions
|
|
67
|
+
4 - **Write error tests**: Cover error conditions
|
|
68
|
+
5 - **Run tests**: Confirm they fail (RED state)
|
|
69
|
+
|
|
70
|
+
**Artifact**: `test-spec.md` and test files
|
|
71
|
+
**Location**: Path defined by `schema.units` in `.specsmd/aidlc/memory-bank.yaml`
|
|
72
|
+
*(Default: `{intents-path}/{intent}/units/{unit}/test-spec.md`)*
|
|
73
|
+
|
|
74
|
+
**Template Structure**:
|
|
75
|
+
|
|
76
|
+
```markdown
|
|
77
|
+
---
|
|
78
|
+
stage: test-first
|
|
79
|
+
bolt: {bolt-id}
|
|
80
|
+
created: {timestamp}
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
## Test Specification: {unit-name}
|
|
84
|
+
|
|
85
|
+
### Test Cases
|
|
86
|
+
|
|
87
|
+
#### Core Functionality
|
|
88
|
+
|
|
89
|
+
- **{Test name}**: Input: {input} → Expected: {output}
|
|
90
|
+
- **{Test name}**: Input: {input} → Expected: {output}
|
|
91
|
+
|
|
92
|
+
#### Edge Cases
|
|
93
|
+
|
|
94
|
+
- **{Test name}**: Input: {input} → Expected: {output}
|
|
95
|
+
|
|
96
|
+
#### Error Conditions
|
|
97
|
+
|
|
98
|
+
- **{Test name}**: Input: {input} → Expected Error: {error}
|
|
99
|
+
|
|
100
|
+
### Test Run (RED)
|
|
101
|
+
- Total tests: {n}
|
|
102
|
+
- Passing: 0
|
|
103
|
+
- Failing: {n}
|
|
104
|
+
|
|
105
|
+
Status: 🔴 RED (all tests failing as expected)
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
**Completion Criteria**:
|
|
109
|
+
|
|
110
|
+
- [ ] All functionality has tests
|
|
111
|
+
- [ ] Edge cases covered
|
|
112
|
+
- [ ] Error cases covered
|
|
113
|
+
- [ ] All tests compile/parse
|
|
114
|
+
- [ ] All tests fail (RED state)
|
|
115
|
+
|
|
116
|
+
**⛔ HUMAN Checkpoint**: Present test specification and **STOP**. Wait for user to confirm before proceeding to Stage 2.
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
### Stage 2: implement
|
|
121
|
+
|
|
122
|
+
**Objective**: Write minimal code to make tests pass
|
|
123
|
+
|
|
124
|
+
**Duration**: Hours (varies by complexity)
|
|
125
|
+
|
|
126
|
+
**Activities**:
|
|
127
|
+
|
|
128
|
+
1 - **Implement first test**: Write simplest code that passes
|
|
129
|
+
2 - **Iterate through tests**: Make each test pass in turn
|
|
130
|
+
3 - **Run full suite**: Confirm all tests pass
|
|
131
|
+
4 - **Review implementation**: Check for issues
|
|
132
|
+
|
|
133
|
+
**Artifact**: Source code
|
|
134
|
+
**Location**: `src/{unit}/`
|
|
135
|
+
|
|
136
|
+
**Approach**:
|
|
137
|
+
|
|
138
|
+
```text
|
|
139
|
+
for each failing test:
|
|
140
|
+
1. Write simplest code that passes the test
|
|
141
|
+
2. Run tests
|
|
142
|
+
3. Commit if green
|
|
143
|
+
4. Move to next test
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
**Completion Criteria**:
|
|
147
|
+
|
|
148
|
+
- [ ] All tests passing (GREEN state)
|
|
149
|
+
- [ ] Implementation is minimal
|
|
150
|
+
- [ ] No over-engineering
|
|
151
|
+
- [ ] All acceptance criteria met
|
|
152
|
+
|
|
153
|
+
**⛔ HUMAN Checkpoint**: Present implementation summary and **STOP**. Wait for user to confirm before proceeding to Stage 3.
|
|
154
|
+
|
|
155
|
+
---
|
|
156
|
+
|
|
157
|
+
### Stage 3: refactor
|
|
158
|
+
|
|
159
|
+
**Objective**: Improve code quality while keeping tests green
|
|
160
|
+
|
|
161
|
+
**Duration**: Hours (typically 1-2 hours)
|
|
162
|
+
|
|
163
|
+
**Activities**:
|
|
164
|
+
|
|
165
|
+
1 - **Review code**: Identify improvement opportunities
|
|
166
|
+
2 - **Remove duplication**: Apply DRY principle
|
|
167
|
+
3 - **Improve naming**: Make names clear and descriptive
|
|
168
|
+
4 - **Extract functions**: Create clean, focused functions
|
|
169
|
+
5 - **Optimize if needed**: Improve performance where necessary
|
|
170
|
+
6 - **Run tests after each change**: Maintain green state
|
|
171
|
+
|
|
172
|
+
**Artifact**: `refactor-report.md`
|
|
173
|
+
**Location**: Path defined by `schema.units` in `.specsmd/aidlc/memory-bank.yaml`
|
|
174
|
+
*(Default: `{intents-path}/{intent}/units/{unit}/refactor-report.md`)*
|
|
175
|
+
|
|
176
|
+
**Template Structure**:
|
|
177
|
+
|
|
178
|
+
```markdown
|
|
179
|
+
---
|
|
180
|
+
stage: refactor
|
|
181
|
+
bolt: {bolt-id}
|
|
182
|
+
created: {timestamp}
|
|
183
|
+
---
|
|
184
|
+
|
|
185
|
+
## Refactor Report: {unit-name}
|
|
186
|
+
|
|
187
|
+
### Improvements Made
|
|
188
|
+
|
|
189
|
+
- **{Change}**: Before: {old} → After: {new} - Reason: {why}
|
|
190
|
+
|
|
191
|
+
### Code Quality Metrics
|
|
192
|
+
|
|
193
|
+
- **Cyclomatic Complexity**: Before: {n} → After: {n}
|
|
194
|
+
- **Lines of Code**: Before: {n} → After: {n}
|
|
195
|
+
- **Test Coverage**: Before: {n}% → After: {n}%
|
|
196
|
+
|
|
197
|
+
### Test Status
|
|
198
|
+
- All tests: ✅ PASSING
|
|
199
|
+
- Coverage: {n}%
|
|
200
|
+
|
|
201
|
+
### Final State
|
|
202
|
+
Status: 🟢 GREEN (refactored and tested)
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
**Completion Criteria**:
|
|
206
|
+
|
|
207
|
+
- [ ] All tests still passing
|
|
208
|
+
- [ ] Code is clean and readable
|
|
209
|
+
- [ ] No duplication
|
|
210
|
+
- [ ] Functions are small and focused
|
|
211
|
+
- [ ] Naming is clear
|
|
212
|
+
|
|
213
|
+
**⛔ HUMAN Checkpoint**: Present refactor report and **STOP**. Wait for user to confirm bolt completion.
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
## Stage Execution
|
|
218
|
+
|
|
219
|
+
### Sequence
|
|
220
|
+
|
|
221
|
+
```text
|
|
222
|
+
test-first (RED) → implement (GREEN) → refactor (REFACTOR)
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### The TDD Cycle
|
|
226
|
+
|
|
227
|
+
```text
|
|
228
|
+
┌──────────┐
|
|
229
|
+
│ RED │ Write failing test
|
|
230
|
+
└────┬─────┘
|
|
231
|
+
│
|
|
232
|
+
▼
|
|
233
|
+
┌──────────┐
|
|
234
|
+
│ GREEN │ Make it pass
|
|
235
|
+
└────┬─────┘
|
|
236
|
+
│
|
|
237
|
+
▼
|
|
238
|
+
┌──────────┐
|
|
239
|
+
│ REFACTOR │ Improve code
|
|
240
|
+
└────┬─────┘
|
|
241
|
+
│
|
|
242
|
+
└──────► Next test case
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
### State Tracking
|
|
246
|
+
|
|
247
|
+
```yaml
|
|
248
|
+
---
|
|
249
|
+
current_stage: refactor
|
|
250
|
+
stages_completed:
|
|
251
|
+
- name: test-first
|
|
252
|
+
completed: 2024-12-05T10:00:00Z
|
|
253
|
+
tests_written: 15
|
|
254
|
+
- name: implement
|
|
255
|
+
completed: 2024-12-05T12:00:00Z
|
|
256
|
+
tests_passing: 15
|
|
257
|
+
status: in-progress
|
|
258
|
+
---
|
|
259
|
+
```
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# Construction Log Template
|
|
2
|
+
|
|
3
|
+
Use this template to track construction progress and replanning decisions for a unit.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Location
|
|
8
|
+
|
|
9
|
+
`{intents-path}/{intent}/units/{unit}/construction-log.md`
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Template
|
|
14
|
+
|
|
15
|
+
```markdown
|
|
16
|
+
---
|
|
17
|
+
unit: {unit-name}
|
|
18
|
+
intent: {intent-name}
|
|
19
|
+
created: {YYYY-MM-DD}
|
|
20
|
+
last_updated: {YYYY-MM-DD}
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
# Construction Log: {unit-name}
|
|
24
|
+
|
|
25
|
+
## Original Plan
|
|
26
|
+
|
|
27
|
+
**From Inception**: {number} bolts planned
|
|
28
|
+
**Planned Date**: {inception-date}
|
|
29
|
+
|
|
30
|
+
| Bolt ID | Stories | Type |
|
|
31
|
+
|---------|---------|------|
|
|
32
|
+
| {bolt-1} | {stories} | {type} |
|
|
33
|
+
| {bolt-2} | {stories} | {type} |
|
|
34
|
+
|
|
35
|
+
## Replanning History
|
|
36
|
+
|
|
37
|
+
| Date | Action | Change | Reason | Approved |
|
|
38
|
+
|------|--------|--------|--------|----------|
|
|
39
|
+
|
|
40
|
+
## Current Bolt Structure
|
|
41
|
+
|
|
42
|
+
| Bolt ID | Stories | Status | Changed |
|
|
43
|
+
|---------|---------|--------|---------|
|
|
44
|
+
| {bolt-1} | {stories} | ✅ completed | - |
|
|
45
|
+
| {bolt-2} | {stories} | ⏳ in-progress | - |
|
|
46
|
+
| {bolt-3} | {stories} | [ ] planned | Split from bolt-2 |
|
|
47
|
+
|
|
48
|
+
## Execution History
|
|
49
|
+
|
|
50
|
+
| Date | Bolt | Event | Details |
|
|
51
|
+
|------|------|-------|---------|
|
|
52
|
+
| {date} | {bolt-id} | started | Stage 1: {stage-name} |
|
|
53
|
+
| {date} | {bolt-id} | stage-complete | {stage} → {next-stage} |
|
|
54
|
+
| {date} | {bolt-id} | completed | All {n} stages done |
|
|
55
|
+
|
|
56
|
+
## Execution Summary
|
|
57
|
+
|
|
58
|
+
| Metric | Value |
|
|
59
|
+
|--------|-------|
|
|
60
|
+
| Original bolts planned | {n} |
|
|
61
|
+
| Current bolt count | {n} |
|
|
62
|
+
| Bolts completed | {n} |
|
|
63
|
+
| Bolts in progress | {n} |
|
|
64
|
+
| Bolts remaining | {n} |
|
|
65
|
+
| Replanning events | {n} |
|
|
66
|
+
|
|
67
|
+
## Notes
|
|
68
|
+
|
|
69
|
+
{Any additional observations or decisions made during construction}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## When to Create
|
|
75
|
+
|
|
76
|
+
Create this file when:
|
|
77
|
+
|
|
78
|
+
1. First bolt for a unit starts (initialize with original plan)
|
|
79
|
+
2. Any replanning action occurs (append, split, reorder)
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
## When to Update
|
|
84
|
+
|
|
85
|
+
Update this file when:
|
|
86
|
+
|
|
87
|
+
1. A bolt starts (add to Execution History, update Current Bolt Structure)
|
|
88
|
+
2. A stage completes (add to Execution History)
|
|
89
|
+
3. A bolt completes (add to Execution History, update Current Bolt Structure, update Execution Summary)
|
|
90
|
+
4. A replanning action occurs (add to Replanning History, update Current Bolt Structure)
|
|
91
|
+
5. Construction completes (add final summary to Notes)
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
## Replanning History Actions
|
|
96
|
+
|
|
97
|
+
| Action | Description |
|
|
98
|
+
|--------|-------------|
|
|
99
|
+
| `append` | New bolt(s) added to plan |
|
|
100
|
+
| `split` | Existing bolt split into multiple |
|
|
101
|
+
| `reorder` | Execution order changed |
|
|
102
|
+
| `scope-change` | Stories added/removed from bolt |
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## Example Entries
|
|
107
|
+
|
|
108
|
+
### Replanning History Example
|
|
109
|
+
|
|
110
|
+
```markdown
|
|
111
|
+
| Date | Action | Change | Reason | Approved |
|
|
112
|
+
|------|--------|--------|--------|----------|
|
|
113
|
+
| 2025-12-07 | split | bolt-2 → bolt-2, bolt-3 | Scope too large for single bolt | Yes |
|
|
114
|
+
| 2025-12-08 | append | Added bolt-4 | New stories from feedback | Yes |
|
|
115
|
+
| 2025-12-09 | reorder | bolt-4 before bolt-3 | Dependency discovered | Yes |
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### Execution History Example
|
|
119
|
+
|
|
120
|
+
```markdown
|
|
121
|
+
| Date | Bolt | Event | Details |
|
|
122
|
+
|------|------|-------|---------|
|
|
123
|
+
| 2025-12-07 | bolt-auth-1 | started | Stage 1: Model |
|
|
124
|
+
| 2025-12-07 | bolt-auth-1 | stage-complete | Model → Design |
|
|
125
|
+
| 2025-12-07 | bolt-auth-1 | stage-complete | Design → Implement |
|
|
126
|
+
| 2025-12-08 | bolt-auth-1 | stage-complete | Implement → Test |
|
|
127
|
+
| 2025-12-08 | bolt-auth-1 | completed | All 4 stages done |
|
|
128
|
+
| 2025-12-08 | bolt-auth-2 | started | Stage 1: Model |
|
|
129
|
+
```
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# Coding Standards
|
|
2
|
+
|
|
3
|
+
## General Principles
|
|
4
|
+
|
|
5
|
+
- {e.g., DRY, KISS, SOLID}
|
|
6
|
+
- {e.g., Clean Code practices}
|
|
7
|
+
|
|
8
|
+
## Naming Conventions
|
|
9
|
+
|
|
10
|
+
- Variables: {e.g., camelCase}
|
|
11
|
+
- Functions: {e.g., camelCase}
|
|
12
|
+
- Classes: {e.g., PascalCase}
|
|
13
|
+
- Files: {e.g., kebab-case}
|
|
14
|
+
|
|
15
|
+
## Formatting
|
|
16
|
+
|
|
17
|
+
- Indentation: {e.g., 2 spaces}
|
|
18
|
+
- Line Length: {e.g., 80 characters}
|
|
19
|
+
- Braces: {e.g., K&R style}
|
|
20
|
+
|
|
21
|
+
## Comments & Documentation
|
|
22
|
+
|
|
23
|
+
- {e.g., JSDoc for functions}
|
|
24
|
+
- {e.g., Explain WHY, not WHAT}
|
|
25
|
+
|
|
26
|
+
## Testing
|
|
27
|
+
|
|
28
|
+
- {e.g., Unit tests for all business logic}
|
|
29
|
+
- {e.g., Integration tests for API endpoints}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# System Architecture
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
{High-level system description}
|
|
6
|
+
|
|
7
|
+
## Architecture Diagram
|
|
8
|
+
|
|
9
|
+
{Mermaid diagram or description}
|
|
10
|
+
|
|
11
|
+
## Components
|
|
12
|
+
|
|
13
|
+
- {Component 1}: {Purpose}
|
|
14
|
+
- {Component 2}: {Purpose}
|
|
15
|
+
|
|
16
|
+
## Data Flow
|
|
17
|
+
|
|
18
|
+
{How data moves through the system}
|
|
19
|
+
|
|
20
|
+
## Technology Stack
|
|
21
|
+
|
|
22
|
+
{Languages, frameworks, databases, etc.}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Tech Stack
|
|
2
|
+
|
|
3
|
+
## Core Technologies
|
|
4
|
+
|
|
5
|
+
- Language: {e.g., TypeScript, Python}
|
|
6
|
+
- Framework: {e.g., React, Next.js, Django}
|
|
7
|
+
- Database: {e.g., PostgreSQL, MongoDB}
|
|
8
|
+
|
|
9
|
+
## Infrastructure
|
|
10
|
+
|
|
11
|
+
- Cloud Provider: {e.g., AWS, GCP}
|
|
12
|
+
- Containerization: {e.g., Docker, Kubernetes}
|
|
13
|
+
- CI/CD: {e.g., GitHub Actions}
|
|
14
|
+
|
|
15
|
+
## Tools & Libraries
|
|
16
|
+
|
|
17
|
+
- Testing: {e.g., Jest, Pytest}
|
|
18
|
+
- Linting: {e.g., ESLint, Pylint}
|
|
19
|
+
- Documentation: {e.g., MkDocs, Storybook}
|
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
# Inception Log Template
|
|
2
|
+
|
|
3
|
+
Use this template to track inception progress and decisions for an intent.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Location
|
|
8
|
+
|
|
9
|
+
`{intents-path}/{intent}/inception-log.md`
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Template
|
|
14
|
+
|
|
15
|
+
```markdown
|
|
16
|
+
---
|
|
17
|
+
intent: {intent-name}
|
|
18
|
+
created: {YYYY-MM-DD}
|
|
19
|
+
completed: {YYYY-MM-DD or null}
|
|
20
|
+
status: {in-progress | complete}
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
# Inception Log: {intent-name}
|
|
24
|
+
|
|
25
|
+
## Overview
|
|
26
|
+
|
|
27
|
+
**Intent**: {brief description}
|
|
28
|
+
**Type**: {green-field | brown-field | defect-fix | refactoring}
|
|
29
|
+
**Created**: {date}
|
|
30
|
+
|
|
31
|
+
## Artifacts Created
|
|
32
|
+
|
|
33
|
+
| Artifact | Status | File |
|
|
34
|
+
|----------|--------|------|
|
|
35
|
+
| Requirements | ✅ | requirements.md |
|
|
36
|
+
| System Context | ✅ | system-context.md |
|
|
37
|
+
| Units | ✅ | units/{unit-name}/unit-brief.md |
|
|
38
|
+
| Stories | ✅ | units/{unit-name}/stories/*.md |
|
|
39
|
+
| Bolt Plan | ✅ | memory-bank/bolts/bolt-*.md |
|
|
40
|
+
|
|
41
|
+
## Summary
|
|
42
|
+
|
|
43
|
+
| Metric | Count |
|
|
44
|
+
|--------|-------|
|
|
45
|
+
| Functional Requirements | {n} |
|
|
46
|
+
| Non-Functional Requirements | {n} |
|
|
47
|
+
| Units | {n} |
|
|
48
|
+
| Stories | {n} |
|
|
49
|
+
| Bolts Planned | {n} |
|
|
50
|
+
|
|
51
|
+
## Units Breakdown
|
|
52
|
+
|
|
53
|
+
| Unit | Stories | Bolts | Priority |
|
|
54
|
+
|------|---------|-------|----------|
|
|
55
|
+
| {unit-1} | {n} | {n} | Must |
|
|
56
|
+
| {unit-2} | {n} | {n} | Should |
|
|
57
|
+
|
|
58
|
+
## Decision Log
|
|
59
|
+
|
|
60
|
+
| Date | Decision | Rationale | Approved |
|
|
61
|
+
|------|----------|-----------|----------|
|
|
62
|
+
|
|
63
|
+
## Scope Changes
|
|
64
|
+
|
|
65
|
+
| Date | Change | Reason | Impact |
|
|
66
|
+
|------|--------|--------|--------|
|
|
67
|
+
|
|
68
|
+
## Ready for Construction
|
|
69
|
+
|
|
70
|
+
**Checklist**:
|
|
71
|
+
- [ ] All requirements documented
|
|
72
|
+
- [ ] System context defined
|
|
73
|
+
- [ ] Units decomposed
|
|
74
|
+
- [ ] Stories created for all units
|
|
75
|
+
- [ ] Bolts planned
|
|
76
|
+
- [ ] Human review complete
|
|
77
|
+
|
|
78
|
+
## Next Steps
|
|
79
|
+
|
|
80
|
+
1. Begin Construction Phase
|
|
81
|
+
2. Start with Unit: {first-unit}
|
|
82
|
+
3. Execute: `/specsmd-construction-agent --unit="{first-unit}"`
|
|
83
|
+
|
|
84
|
+
## Dependencies
|
|
85
|
+
|
|
86
|
+
{Execution order based on unit dependencies}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## When to Create
|
|
92
|
+
|
|
93
|
+
Create this file when:
|
|
94
|
+
|
|
95
|
+
1. Intent is created (intent-create skill)
|
|
96
|
+
2. Initialize with basic metadata and empty sections
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## When to Update
|
|
101
|
+
|
|
102
|
+
Update this file when:
|
|
103
|
+
|
|
104
|
+
1. An artifact is completed (update Artifacts Created table)
|
|
105
|
+
2. A decision is made during inception (add to Decision Log)
|
|
106
|
+
3. Scope changes (add to Scope Changes)
|
|
107
|
+
4. Inception completes (mark status complete, fill summary)
|
|
108
|
+
|
|
109
|
+
---
|
|
110
|
+
|
|
111
|
+
## Decision Log Examples
|
|
112
|
+
|
|
113
|
+
```markdown
|
|
114
|
+
## Decision Log
|
|
115
|
+
|
|
116
|
+
| Date | Decision | Rationale | Approved |
|
|
117
|
+
|------|----------|-----------|----------|
|
|
118
|
+
| 2025-12-07 | Split auth into 2 units | Separation of concerns | Yes |
|
|
119
|
+
| 2025-12-07 | Use JWT over sessions | Stateless API requirement | Yes |
|
|
120
|
+
| 2025-12-08 | Add MFA to scope | Security requirement from review | Yes |
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## Scope Changes Examples
|
|
126
|
+
|
|
127
|
+
```markdown
|
|
128
|
+
## Scope Changes
|
|
129
|
+
|
|
130
|
+
| Date | Change | Reason | Impact |
|
|
131
|
+
|------|--------|--------|--------|
|
|
132
|
+
| 2025-12-08 | Added MFA stories | Security requirement | +2 stories, +1 bolt |
|
|
133
|
+
| 2025-12-09 | Removed social login | Out of scope for MVP | -3 stories, -1 bolt |
|
|
134
|
+
```
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# Project Context
|
|
2
|
+
|
|
3
|
+
This directory contains project-level context and metadata.
|
|
4
|
+
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
The `memory-bank/project/` directory stores information about your overall project that persists across all intents and units.
|
|
8
|
+
|
|
9
|
+
## Files to Create
|
|
10
|
+
|
|
11
|
+
- **project-brief.md**: High-level project overview, goals, and scope
|
|
12
|
+
- **tech-stack.md**: Technology choices and rationale
|
|
13
|
+
- **team.md**: Team structure and roles
|
|
14
|
+
- **conventions.md**: Coding standards, naming conventions, etc.
|
|
15
|
+
|
|
16
|
+
## Example: project-brief.md
|
|
17
|
+
|
|
18
|
+
```markdown
|
|
19
|
+
---
|
|
20
|
+
created: 2024-11-22
|
|
21
|
+
updated: 2024-11-22
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
# Project Brief
|
|
25
|
+
|
|
26
|
+
## Project Name
|
|
27
|
+
{Your project name}
|
|
28
|
+
|
|
29
|
+
## Overview
|
|
30
|
+
{Brief description of what this project does}
|
|
31
|
+
|
|
32
|
+
## Business Goals
|
|
33
|
+
- {Goal 1}
|
|
34
|
+
- {Goal 2}
|
|
35
|
+
|
|
36
|
+
## Target Users
|
|
37
|
+
{Who will use this system}
|
|
38
|
+
|
|
39
|
+
## Success Criteria
|
|
40
|
+
- {Measurable criterion 1}
|
|
41
|
+
- {Measurable criterion 2}
|
|
42
|
+
|
|
43
|
+
## Timeline
|
|
44
|
+
- Inception: {dates}
|
|
45
|
+
- Construction: {dates}
|
|
46
|
+
- Launch: {target date}
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Getting Started
|
|
50
|
+
|
|
51
|
+
1. Create `project-brief.md` with your project overview
|
|
52
|
+
2. Document your tech stack in `tech-stack.md`
|
|
53
|
+
3. Add any other project-level context as needed
|
|
54
|
+
|
|
55
|
+
These files will be referenced by agents throughout the AI-DLC workflow.
|