claude-code-orchestrator-kit 1.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/.claude/agents/database/workers/api-builder.md +155 -0
- package/.claude/agents/database/workers/database-architect.md +193 -0
- package/.claude/agents/database/workers/supabase-auditor.md +1070 -0
- package/.claude/agents/development/workers/code-reviewer.md +968 -0
- package/.claude/agents/development/workers/cost-calculator-specialist.md +683 -0
- package/.claude/agents/development/workers/llm-service-specialist.md +999 -0
- package/.claude/agents/development/workers/skill-builder-v2.md +480 -0
- package/.claude/agents/development/workers/typescript-types-specialist.md +649 -0
- package/.claude/agents/development/workers/utility-builder.md +582 -0
- package/.claude/agents/documentation/workers/technical-writer.md +152 -0
- package/.claude/agents/frontend/workers/fullstack-nextjs-specialist.md +206 -0
- package/.claude/agents/frontend/workers/visual-effects-creator.md +159 -0
- package/.claude/agents/health/orchestrators/bug-orchestrator.md +1045 -0
- package/.claude/agents/health/orchestrators/dead-code-orchestrator.md +1045 -0
- package/.claude/agents/health/orchestrators/dependency-orchestrator.md +1045 -0
- package/.claude/agents/health/orchestrators/security-orchestrator.md +1045 -0
- package/.claude/agents/health/workers/bug-fixer.md +525 -0
- package/.claude/agents/health/workers/bug-hunter.md +649 -0
- package/.claude/agents/health/workers/dead-code-hunter.md +446 -0
- package/.claude/agents/health/workers/dead-code-remover.md +437 -0
- package/.claude/agents/health/workers/dependency-auditor.md +379 -0
- package/.claude/agents/health/workers/dependency-updater.md +436 -0
- package/.claude/agents/health/workers/security-scanner.md +700 -0
- package/.claude/agents/health/workers/vulnerability-fixer.md +524 -0
- package/.claude/agents/infrastructure/workers/infrastructure-specialist.md +156 -0
- package/.claude/agents/infrastructure/workers/orchestration-logic-specialist.md +1260 -0
- package/.claude/agents/infrastructure/workers/qdrant-specialist.md +503 -0
- package/.claude/agents/infrastructure/workers/quality-validator-specialist.md +984 -0
- package/.claude/agents/meta/workers/meta-agent-v3.md +503 -0
- package/.claude/agents/research/workers/problem-investigator.md +507 -0
- package/.claude/agents/research/workers/research-specialist.md +423 -0
- package/.claude/agents/testing/workers/accessibility-tester.md +813 -0
- package/.claude/agents/testing/workers/integration-tester.md +188 -0
- package/.claude/agents/testing/workers/mobile-fixes-implementer.md +252 -0
- package/.claude/agents/testing/workers/mobile-responsiveness-tester.md +180 -0
- package/.claude/agents/testing/workers/performance-optimizer.md +262 -0
- package/.claude/agents/testing/workers/test-writer.md +800 -0
- package/.claude/commands/health-bugs.md +297 -0
- package/.claude/commands/health-cleanup.md +297 -0
- package/.claude/commands/health-deps.md +297 -0
- package/.claude/commands/health-metrics.md +747 -0
- package/.claude/commands/health-security.md +297 -0
- package/.claude/commands/push.md +21 -0
- package/.claude/commands/speckit.analyze.md +184 -0
- package/.claude/commands/speckit.checklist.md +294 -0
- package/.claude/commands/speckit.clarify.md +178 -0
- package/.claude/commands/speckit.constitution.md +78 -0
- package/.claude/commands/speckit.implement.md +182 -0
- package/.claude/commands/speckit.plan.md +87 -0
- package/.claude/commands/speckit.specify.md +250 -0
- package/.claude/commands/speckit.tasks.md +137 -0
- package/.claude/commands/translate-doc.md +95 -0
- package/.claude/commands/worktree-cleanup.md +382 -0
- package/.claude/commands/worktree-create.md +287 -0
- package/.claude/commands/worktree-list.md +239 -0
- package/.claude/commands/worktree-remove.md +339 -0
- package/.claude/schemas/base-plan.schema.json +82 -0
- package/.claude/schemas/bug-plan.schema.json +71 -0
- package/.claude/schemas/dead-code-plan.schema.json +71 -0
- package/.claude/schemas/dependency-plan.schema.json +74 -0
- package/.claude/schemas/security-plan.schema.json +71 -0
- package/.claude/scripts/gates/check-bundle-size.sh +47 -0
- package/.claude/scripts/gates/check-coverage.sh +67 -0
- package/.claude/scripts/gates/check-security.sh +46 -0
- package/.claude/scripts/release.sh +740 -0
- package/.claude/settings.local.json +21 -0
- package/.claude/settings.local.json.example +20 -0
- package/.claude/skills/calculate-priority-score/SKILL.md +229 -0
- package/.claude/skills/calculate-priority-score/scoring-matrix.json +83 -0
- package/.claude/skills/extract-version/SKILL.md +228 -0
- package/.claude/skills/format-commit-message/SKILL.md +189 -0
- package/.claude/skills/format-commit-message/template.md +64 -0
- package/.claude/skills/format-markdown-table/SKILL.md +202 -0
- package/.claude/skills/format-markdown-table/examples.md +84 -0
- package/.claude/skills/format-todo-list/SKILL.md +222 -0
- package/.claude/skills/format-todo-list/template.json +30 -0
- package/.claude/skills/generate-changelog/SKILL.md +258 -0
- package/.claude/skills/generate-changelog/commit-mapping.json +47 -0
- package/.claude/skills/generate-report-header/SKILL.md +228 -0
- package/.claude/skills/generate-report-header/template.md +66 -0
- package/.claude/skills/parse-error-logs/SKILL.md +286 -0
- package/.claude/skills/parse-error-logs/patterns.json +26 -0
- package/.claude/skills/parse-git-status/SKILL.md +164 -0
- package/.claude/skills/parse-package-json/SKILL.md +151 -0
- package/.claude/skills/parse-package-json/schema.json +43 -0
- package/.claude/skills/render-template/SKILL.md +245 -0
- package/.claude/skills/rollback-changes/SKILL.md +582 -0
- package/.claude/skills/rollback-changes/changes-log-schema.json +101 -0
- package/.claude/skills/run-quality-gate/SKILL.md +404 -0
- package/.claude/skills/run-quality-gate/gate-mappings.json +97 -0
- package/.claude/skills/validate-plan-file/SKILL.md +327 -0
- package/.claude/skills/validate-plan-file/schema.json +35 -0
- package/.claude/skills/validate-report-file/SKILL.md +256 -0
- package/.claude/skills/validate-report-file/schema.json +67 -0
- package/.env.example +49 -0
- package/.github/BRANCH_PROTECTION.md +137 -0
- package/.github/workflows/build.yml +70 -0
- package/.github/workflows/claude-code-review.yml +255 -0
- package/.github/workflows/claude.yml +79 -0
- package/.github/workflows/deploy-staging.yml +90 -0
- package/.github/workflows/test.yml +104 -0
- package/.gitignore +116 -0
- package/CLAUDE.md +137 -0
- package/LICENSE +72 -0
- package/README.md +1098 -0
- package/docs/ARCHITECTURE.md +746 -0
- package/docs/Agents Ecosystem/AGENT-ORCHESTRATION.md +568 -0
- package/docs/Agents Ecosystem/AI-AGENT-ECOSYSTEM-README.md +658 -0
- package/docs/Agents Ecosystem/ARCHITECTURE.md +606 -0
- package/docs/Agents Ecosystem/QUALITY-GATES-SPECIFICATION.md +1315 -0
- package/docs/Agents Ecosystem/REPORT-TEMPLATE-STANDARD.md +1324 -0
- package/docs/Agents Ecosystem/spec-kit-comprehensive-updates.md +478 -0
- package/docs/FAQ.md +572 -0
- package/docs/MIGRATION-GUIDE.md +542 -0
- package/docs/PERFORMANCE-OPTIMIZATION.md +494 -0
- package/docs/ROADMAP.md +439 -0
- package/docs/TUTORIAL-CUSTOM-AGENTS.md +2041 -0
- package/docs/USE-CASES.md +706 -0
- package/index.js +96 -0
- package/mcp/.mcp.base.json +21 -0
- package/mcp/.mcp.frontend.json +29 -0
- package/mcp/.mcp.full.json +67 -0
- package/mcp/.mcp.local.example.json +7 -0
- package/mcp/.mcp.local.json +7 -0
- package/mcp/.mcp.n8n.json +45 -0
- package/mcp/.mcp.supabase-full.json +35 -0
- package/mcp/.mcp.supabase-only.json +28 -0
- package/package.json +78 -0
- package/postinstall.js +71 -0
- package/switch-mcp.sh +101 -0
|
@@ -0,0 +1,294 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Generate a custom checklist for the current feature based on user requirements.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## Checklist Purpose: "Unit Tests for English"
|
|
6
|
+
|
|
7
|
+
**CRITICAL CONCEPT**: Checklists are **UNIT TESTS FOR REQUIREMENTS WRITING** - they validate the quality, clarity, and completeness of requirements in a given domain.
|
|
8
|
+
|
|
9
|
+
**NOT for verification/testing**:
|
|
10
|
+
|
|
11
|
+
- ❌ NOT "Verify the button clicks correctly"
|
|
12
|
+
- ❌ NOT "Test error handling works"
|
|
13
|
+
- ❌ NOT "Confirm the API returns 200"
|
|
14
|
+
- ❌ NOT checking if code/implementation matches the spec
|
|
15
|
+
|
|
16
|
+
**FOR requirements quality validation**:
|
|
17
|
+
|
|
18
|
+
- ✅ "Are visual hierarchy requirements defined for all card types?" (completeness)
|
|
19
|
+
- ✅ "Is 'prominent display' quantified with specific sizing/positioning?" (clarity)
|
|
20
|
+
- ✅ "Are hover state requirements consistent across all interactive elements?" (consistency)
|
|
21
|
+
- ✅ "Are accessibility requirements defined for keyboard navigation?" (coverage)
|
|
22
|
+
- ✅ "Does the spec define what happens when logo image fails to load?" (edge cases)
|
|
23
|
+
|
|
24
|
+
**Metaphor**: If your spec is code written in English, the checklist is its unit test suite. You're testing whether the requirements are well-written, complete, unambiguous, and ready for implementation - NOT whether the implementation works.
|
|
25
|
+
|
|
26
|
+
## User Input
|
|
27
|
+
|
|
28
|
+
```text
|
|
29
|
+
$ARGUMENTS
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
You **MUST** consider the user input before proceeding (if not empty).
|
|
33
|
+
|
|
34
|
+
## Execution Steps
|
|
35
|
+
|
|
36
|
+
1. **Setup**: Run `.specify/scripts/bash/check-prerequisites.sh --json` from repo root and parse JSON for FEATURE_DIR and AVAILABLE_DOCS list.
|
|
37
|
+
- All file paths must be absolute.
|
|
38
|
+
- For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
|
|
39
|
+
|
|
40
|
+
2. **Clarify intent (dynamic)**: Derive up to THREE initial contextual clarifying questions (no pre-baked catalog). They MUST:
|
|
41
|
+
- Be generated from the user's phrasing + extracted signals from spec/plan/tasks
|
|
42
|
+
- Only ask about information that materially changes checklist content
|
|
43
|
+
- Be skipped individually if already unambiguous in `$ARGUMENTS`
|
|
44
|
+
- Prefer precision over breadth
|
|
45
|
+
|
|
46
|
+
Generation algorithm:
|
|
47
|
+
1. Extract signals: feature domain keywords (e.g., auth, latency, UX, API), risk indicators ("critical", "must", "compliance"), stakeholder hints ("QA", "review", "security team"), and explicit deliverables ("a11y", "rollback", "contracts").
|
|
48
|
+
2. Cluster signals into candidate focus areas (max 4) ranked by relevance.
|
|
49
|
+
3. Identify probable audience & timing (author, reviewer, QA, release) if not explicit.
|
|
50
|
+
4. Detect missing dimensions: scope breadth, depth/rigor, risk emphasis, exclusion boundaries, measurable acceptance criteria.
|
|
51
|
+
5. Formulate questions chosen from these archetypes:
|
|
52
|
+
- Scope refinement (e.g., "Should this include integration touchpoints with X and Y or stay limited to local module correctness?")
|
|
53
|
+
- Risk prioritization (e.g., "Which of these potential risk areas should receive mandatory gating checks?")
|
|
54
|
+
- Depth calibration (e.g., "Is this a lightweight pre-commit sanity list or a formal release gate?")
|
|
55
|
+
- Audience framing (e.g., "Will this be used by the author only or peers during PR review?")
|
|
56
|
+
- Boundary exclusion (e.g., "Should we explicitly exclude performance tuning items this round?")
|
|
57
|
+
- Scenario class gap (e.g., "No recovery flows detected—are rollback / partial failure paths in scope?")
|
|
58
|
+
|
|
59
|
+
Question formatting rules:
|
|
60
|
+
- If presenting options, generate a compact table with columns: Option | Candidate | Why It Matters
|
|
61
|
+
- Limit to A–E options maximum; omit table if a free-form answer is clearer
|
|
62
|
+
- Never ask the user to restate what they already said
|
|
63
|
+
- Avoid speculative categories (no hallucination). If uncertain, ask explicitly: "Confirm whether X belongs in scope."
|
|
64
|
+
|
|
65
|
+
Defaults when interaction impossible:
|
|
66
|
+
- Depth: Standard
|
|
67
|
+
- Audience: Reviewer (PR) if code-related; Author otherwise
|
|
68
|
+
- Focus: Top 2 relevance clusters
|
|
69
|
+
|
|
70
|
+
Output the questions (label Q1/Q2/Q3). After answers: if ≥2 scenario classes (Alternate / Exception / Recovery / Non-Functional domain) remain unclear, you MAY ask up to TWO more targeted follow‑ups (Q4/Q5) with a one-line justification each (e.g., "Unresolved recovery path risk"). Do not exceed five total questions. Skip escalation if user explicitly declines more.
|
|
71
|
+
|
|
72
|
+
3. **Understand user request**: Combine `$ARGUMENTS` + clarifying answers:
|
|
73
|
+
- Derive checklist theme (e.g., security, review, deploy, ux)
|
|
74
|
+
- Consolidate explicit must-have items mentioned by user
|
|
75
|
+
- Map focus selections to category scaffolding
|
|
76
|
+
- Infer any missing context from spec/plan/tasks (do NOT hallucinate)
|
|
77
|
+
|
|
78
|
+
4. **Load feature context**: Read from FEATURE_DIR:
|
|
79
|
+
- spec.md: Feature requirements and scope
|
|
80
|
+
- plan.md (if exists): Technical details, dependencies
|
|
81
|
+
- tasks.md (if exists): Implementation tasks
|
|
82
|
+
|
|
83
|
+
**Context Loading Strategy**:
|
|
84
|
+
- Load only necessary portions relevant to active focus areas (avoid full-file dumping)
|
|
85
|
+
- Prefer summarizing long sections into concise scenario/requirement bullets
|
|
86
|
+
- Use progressive disclosure: add follow-on retrieval only if gaps detected
|
|
87
|
+
- If source docs are large, generate interim summary items instead of embedding raw text
|
|
88
|
+
|
|
89
|
+
5. **Generate checklist** - Create "Unit Tests for Requirements":
|
|
90
|
+
- Create `FEATURE_DIR/checklists/` directory if it doesn't exist
|
|
91
|
+
- Generate unique checklist filename:
|
|
92
|
+
- Use short, descriptive name based on domain (e.g., `ux.md`, `api.md`, `security.md`)
|
|
93
|
+
- Format: `[domain].md`
|
|
94
|
+
- If file exists, append to existing file
|
|
95
|
+
- Number items sequentially starting from CHK001
|
|
96
|
+
- Each `/speckit.checklist` run creates a NEW file (never overwrites existing checklists)
|
|
97
|
+
|
|
98
|
+
**CORE PRINCIPLE - Test the Requirements, Not the Implementation**:
|
|
99
|
+
Every checklist item MUST evaluate the REQUIREMENTS THEMSELVES for:
|
|
100
|
+
- **Completeness**: Are all necessary requirements present?
|
|
101
|
+
- **Clarity**: Are requirements unambiguous and specific?
|
|
102
|
+
- **Consistency**: Do requirements align with each other?
|
|
103
|
+
- **Measurability**: Can requirements be objectively verified?
|
|
104
|
+
- **Coverage**: Are all scenarios/edge cases addressed?
|
|
105
|
+
|
|
106
|
+
**Category Structure** - Group items by requirement quality dimensions:
|
|
107
|
+
- **Requirement Completeness** (Are all necessary requirements documented?)
|
|
108
|
+
- **Requirement Clarity** (Are requirements specific and unambiguous?)
|
|
109
|
+
- **Requirement Consistency** (Do requirements align without conflicts?)
|
|
110
|
+
- **Acceptance Criteria Quality** (Are success criteria measurable?)
|
|
111
|
+
- **Scenario Coverage** (Are all flows/cases addressed?)
|
|
112
|
+
- **Edge Case Coverage** (Are boundary conditions defined?)
|
|
113
|
+
- **Non-Functional Requirements** (Performance, Security, Accessibility, etc. - are they specified?)
|
|
114
|
+
- **Dependencies & Assumptions** (Are they documented and validated?)
|
|
115
|
+
- **Ambiguities & Conflicts** (What needs clarification?)
|
|
116
|
+
|
|
117
|
+
**HOW TO WRITE CHECKLIST ITEMS - "Unit Tests for English"**:
|
|
118
|
+
|
|
119
|
+
❌ **WRONG** (Testing implementation):
|
|
120
|
+
- "Verify landing page displays 3 episode cards"
|
|
121
|
+
- "Test hover states work on desktop"
|
|
122
|
+
- "Confirm logo click navigates home"
|
|
123
|
+
|
|
124
|
+
✅ **CORRECT** (Testing requirements quality):
|
|
125
|
+
- "Are the exact number and layout of featured episodes specified?" [Completeness]
|
|
126
|
+
- "Is 'prominent display' quantified with specific sizing/positioning?" [Clarity]
|
|
127
|
+
- "Are hover state requirements consistent across all interactive elements?" [Consistency]
|
|
128
|
+
- "Are keyboard navigation requirements defined for all interactive UI?" [Coverage]
|
|
129
|
+
- "Is the fallback behavior specified when logo image fails to load?" [Edge Cases]
|
|
130
|
+
- "Are loading states defined for asynchronous episode data?" [Completeness]
|
|
131
|
+
- "Does the spec define visual hierarchy for competing UI elements?" [Clarity]
|
|
132
|
+
|
|
133
|
+
**ITEM STRUCTURE**:
|
|
134
|
+
Each item should follow this pattern:
|
|
135
|
+
- Question format asking about requirement quality
|
|
136
|
+
- Focus on what's WRITTEN (or not written) in the spec/plan
|
|
137
|
+
- Include quality dimension in brackets [Completeness/Clarity/Consistency/etc.]
|
|
138
|
+
- Reference spec section `[Spec §X.Y]` when checking existing requirements
|
|
139
|
+
- Use `[Gap]` marker when checking for missing requirements
|
|
140
|
+
|
|
141
|
+
**EXAMPLES BY QUALITY DIMENSION**:
|
|
142
|
+
|
|
143
|
+
Completeness:
|
|
144
|
+
- "Are error handling requirements defined for all API failure modes? [Gap]"
|
|
145
|
+
- "Are accessibility requirements specified for all interactive elements? [Completeness]"
|
|
146
|
+
- "Are mobile breakpoint requirements defined for responsive layouts? [Gap]"
|
|
147
|
+
|
|
148
|
+
Clarity:
|
|
149
|
+
- "Is 'fast loading' quantified with specific timing thresholds? [Clarity, Spec §NFR-2]"
|
|
150
|
+
- "Are 'related episodes' selection criteria explicitly defined? [Clarity, Spec §FR-5]"
|
|
151
|
+
- "Is 'prominent' defined with measurable visual properties? [Ambiguity, Spec §FR-4]"
|
|
152
|
+
|
|
153
|
+
Consistency:
|
|
154
|
+
- "Do navigation requirements align across all pages? [Consistency, Spec §FR-10]"
|
|
155
|
+
- "Are card component requirements consistent between landing and detail pages? [Consistency]"
|
|
156
|
+
|
|
157
|
+
Coverage:
|
|
158
|
+
- "Are requirements defined for zero-state scenarios (no episodes)? [Coverage, Edge Case]"
|
|
159
|
+
- "Are concurrent user interaction scenarios addressed? [Coverage, Gap]"
|
|
160
|
+
- "Are requirements specified for partial data loading failures? [Coverage, Exception Flow]"
|
|
161
|
+
|
|
162
|
+
Measurability:
|
|
163
|
+
- "Are visual hierarchy requirements measurable/testable? [Acceptance Criteria, Spec §FR-1]"
|
|
164
|
+
- "Can 'balanced visual weight' be objectively verified? [Measurability, Spec §FR-2]"
|
|
165
|
+
|
|
166
|
+
**Scenario Classification & Coverage** (Requirements Quality Focus):
|
|
167
|
+
- Check if requirements exist for: Primary, Alternate, Exception/Error, Recovery, Non-Functional scenarios
|
|
168
|
+
- For each scenario class, ask: "Are [scenario type] requirements complete, clear, and consistent?"
|
|
169
|
+
- If scenario class missing: "Are [scenario type] requirements intentionally excluded or missing? [Gap]"
|
|
170
|
+
- Include resilience/rollback when state mutation occurs: "Are rollback requirements defined for migration failures? [Gap]"
|
|
171
|
+
|
|
172
|
+
**Traceability Requirements**:
|
|
173
|
+
- MINIMUM: ≥80% of items MUST include at least one traceability reference
|
|
174
|
+
- Each item should reference: spec section `[Spec §X.Y]`, or use markers: `[Gap]`, `[Ambiguity]`, `[Conflict]`, `[Assumption]`
|
|
175
|
+
- If no ID system exists: "Is a requirement & acceptance criteria ID scheme established? [Traceability]"
|
|
176
|
+
|
|
177
|
+
**Surface & Resolve Issues** (Requirements Quality Problems):
|
|
178
|
+
Ask questions about the requirements themselves:
|
|
179
|
+
- Ambiguities: "Is the term 'fast' quantified with specific metrics? [Ambiguity, Spec §NFR-1]"
|
|
180
|
+
- Conflicts: "Do navigation requirements conflict between §FR-10 and §FR-10a? [Conflict]"
|
|
181
|
+
- Assumptions: "Is the assumption of 'always available podcast API' validated? [Assumption]"
|
|
182
|
+
- Dependencies: "Are external podcast API requirements documented? [Dependency, Gap]"
|
|
183
|
+
- Missing definitions: "Is 'visual hierarchy' defined with measurable criteria? [Gap]"
|
|
184
|
+
|
|
185
|
+
**Content Consolidation**:
|
|
186
|
+
- Soft cap: If raw candidate items > 40, prioritize by risk/impact
|
|
187
|
+
- Merge near-duplicates checking the same requirement aspect
|
|
188
|
+
- If >5 low-impact edge cases, create one item: "Are edge cases X, Y, Z addressed in requirements? [Coverage]"
|
|
189
|
+
|
|
190
|
+
**🚫 ABSOLUTELY PROHIBITED** - These make it an implementation test, not a requirements test:
|
|
191
|
+
- ❌ Any item starting with "Verify", "Test", "Confirm", "Check" + implementation behavior
|
|
192
|
+
- ❌ References to code execution, user actions, system behavior
|
|
193
|
+
- ❌ "Displays correctly", "works properly", "functions as expected"
|
|
194
|
+
- ❌ "Click", "navigate", "render", "load", "execute"
|
|
195
|
+
- ❌ Test cases, test plans, QA procedures
|
|
196
|
+
- ❌ Implementation details (frameworks, APIs, algorithms)
|
|
197
|
+
|
|
198
|
+
**✅ REQUIRED PATTERNS** - These test requirements quality:
|
|
199
|
+
- ✅ "Are [requirement type] defined/specified/documented for [scenario]?"
|
|
200
|
+
- ✅ "Is [vague term] quantified/clarified with specific criteria?"
|
|
201
|
+
- ✅ "Are requirements consistent between [section A] and [section B]?"
|
|
202
|
+
- ✅ "Can [requirement] be objectively measured/verified?"
|
|
203
|
+
- ✅ "Are [edge cases/scenarios] addressed in requirements?"
|
|
204
|
+
- ✅ "Does the spec define [missing aspect]?"
|
|
205
|
+
|
|
206
|
+
6. **Structure Reference**: Generate the checklist following the canonical template in `.specify/templates/checklist-template.md` for title, meta section, category headings, and ID formatting. If template is unavailable, use: H1 title, purpose/created meta lines, `##` category sections containing `- [ ] CHK### <requirement item>` lines with globally incrementing IDs starting at CHK001.
|
|
207
|
+
|
|
208
|
+
7. **Report**: Output full path to created checklist, item count, and remind user that each run creates a new file. Summarize:
|
|
209
|
+
- Focus areas selected
|
|
210
|
+
- Depth level
|
|
211
|
+
- Actor/timing
|
|
212
|
+
- Any explicit user-specified must-have items incorporated
|
|
213
|
+
|
|
214
|
+
**Important**: Each `/speckit.checklist` command invocation creates a checklist file using short, descriptive names unless file already exists. This allows:
|
|
215
|
+
|
|
216
|
+
- Multiple checklists of different types (e.g., `ux.md`, `test.md`, `security.md`)
|
|
217
|
+
- Simple, memorable filenames that indicate checklist purpose
|
|
218
|
+
- Easy identification and navigation in the `checklists/` folder
|
|
219
|
+
|
|
220
|
+
To avoid clutter, use descriptive types and clean up obsolete checklists when done.
|
|
221
|
+
|
|
222
|
+
## Example Checklist Types & Sample Items
|
|
223
|
+
|
|
224
|
+
**UX Requirements Quality:** `ux.md`
|
|
225
|
+
|
|
226
|
+
Sample items (testing the requirements, NOT the implementation):
|
|
227
|
+
|
|
228
|
+
- "Are visual hierarchy requirements defined with measurable criteria? [Clarity, Spec §FR-1]"
|
|
229
|
+
- "Is the number and positioning of UI elements explicitly specified? [Completeness, Spec §FR-1]"
|
|
230
|
+
- "Are interaction state requirements (hover, focus, active) consistently defined? [Consistency]"
|
|
231
|
+
- "Are accessibility requirements specified for all interactive elements? [Coverage, Gap]"
|
|
232
|
+
- "Is fallback behavior defined when images fail to load? [Edge Case, Gap]"
|
|
233
|
+
- "Can 'prominent display' be objectively measured? [Measurability, Spec §FR-4]"
|
|
234
|
+
|
|
235
|
+
**API Requirements Quality:** `api.md`
|
|
236
|
+
|
|
237
|
+
Sample items:
|
|
238
|
+
|
|
239
|
+
- "Are error response formats specified for all failure scenarios? [Completeness]"
|
|
240
|
+
- "Are rate limiting requirements quantified with specific thresholds? [Clarity]"
|
|
241
|
+
- "Are authentication requirements consistent across all endpoints? [Consistency]"
|
|
242
|
+
- "Are retry/timeout requirements defined for external dependencies? [Coverage, Gap]"
|
|
243
|
+
- "Is versioning strategy documented in requirements? [Gap]"
|
|
244
|
+
|
|
245
|
+
**Performance Requirements Quality:** `performance.md`
|
|
246
|
+
|
|
247
|
+
Sample items:
|
|
248
|
+
|
|
249
|
+
- "Are performance requirements quantified with specific metrics? [Clarity]"
|
|
250
|
+
- "Are performance targets defined for all critical user journeys? [Coverage]"
|
|
251
|
+
- "Are performance requirements under different load conditions specified? [Completeness]"
|
|
252
|
+
- "Can performance requirements be objectively measured? [Measurability]"
|
|
253
|
+
- "Are degradation requirements defined for high-load scenarios? [Edge Case, Gap]"
|
|
254
|
+
|
|
255
|
+
**Security Requirements Quality:** `security.md`
|
|
256
|
+
|
|
257
|
+
Sample items:
|
|
258
|
+
|
|
259
|
+
- "Are authentication requirements specified for all protected resources? [Coverage]"
|
|
260
|
+
- "Are data protection requirements defined for sensitive information? [Completeness]"
|
|
261
|
+
- "Is the threat model documented and requirements aligned to it? [Traceability]"
|
|
262
|
+
- "Are security requirements consistent with compliance obligations? [Consistency]"
|
|
263
|
+
- "Are security failure/breach response requirements defined? [Gap, Exception Flow]"
|
|
264
|
+
|
|
265
|
+
## Anti-Examples: What NOT To Do
|
|
266
|
+
|
|
267
|
+
**❌ WRONG - These test implementation, not requirements:**
|
|
268
|
+
|
|
269
|
+
```markdown
|
|
270
|
+
- [ ] CHK001 - Verify landing page displays 3 episode cards [Spec §FR-001]
|
|
271
|
+
- [ ] CHK002 - Test hover states work correctly on desktop [Spec §FR-003]
|
|
272
|
+
- [ ] CHK003 - Confirm logo click navigates to home page [Spec §FR-010]
|
|
273
|
+
- [ ] CHK004 - Check that related episodes section shows 3-5 items [Spec §FR-005]
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
**✅ CORRECT - These test requirements quality:**
|
|
277
|
+
|
|
278
|
+
```markdown
|
|
279
|
+
- [ ] CHK001 - Are the number and layout of featured episodes explicitly specified? [Completeness, Spec §FR-001]
|
|
280
|
+
- [ ] CHK002 - Are hover state requirements consistently defined for all interactive elements? [Consistency, Spec §FR-003]
|
|
281
|
+
- [ ] CHK003 - Are navigation requirements clear for all clickable brand elements? [Clarity, Spec §FR-010]
|
|
282
|
+
- [ ] CHK004 - Is the selection criteria for related episodes documented? [Gap, Spec §FR-005]
|
|
283
|
+
- [ ] CHK005 - Are loading state requirements defined for asynchronous episode data? [Gap]
|
|
284
|
+
- [ ] CHK006 - Can "visual hierarchy" requirements be objectively measured? [Measurability, Spec §FR-001]
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
**Key Differences:**
|
|
288
|
+
|
|
289
|
+
- Wrong: Tests if the system works correctly
|
|
290
|
+
- Correct: Tests if the requirements are written correctly
|
|
291
|
+
- Wrong: Verification of behavior
|
|
292
|
+
- Correct: Validation of requirement quality
|
|
293
|
+
- Wrong: "Does it do X?"
|
|
294
|
+
- Correct: "Is X clearly specified?"
|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Identify underspecified areas in the current feature spec by asking up to 5 highly targeted clarification questions and encoding answers back into the spec.
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## User Input
|
|
6
|
+
|
|
7
|
+
```text
|
|
8
|
+
$ARGUMENTS
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
You **MUST** consider the user input before proceeding (if not empty).
|
|
12
|
+
|
|
13
|
+
## Outline
|
|
14
|
+
|
|
15
|
+
Goal: Detect and reduce ambiguity or missing decision points in the active feature specification and record the clarifications directly in the spec file.
|
|
16
|
+
|
|
17
|
+
Note: This clarification workflow is expected to run (and be completed) BEFORE invoking `/speckit.plan`. If the user explicitly states they are skipping clarification (e.g., exploratory spike), you may proceed, but must warn that downstream rework risk increases.
|
|
18
|
+
|
|
19
|
+
Execution steps:
|
|
20
|
+
|
|
21
|
+
1. Run `.specify/scripts/bash/check-prerequisites.sh --json --paths-only` from repo root **once** (combined `--json --paths-only` mode / `-Json -PathsOnly`). Parse minimal JSON payload fields:
|
|
22
|
+
- `FEATURE_DIR`
|
|
23
|
+
- `FEATURE_SPEC`
|
|
24
|
+
- (Optionally capture `IMPL_PLAN`, `TASKS` for future chained flows.)
|
|
25
|
+
- If JSON parsing fails, abort and instruct user to re-run `/speckit.specify` or verify feature branch environment.
|
|
26
|
+
- For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
|
|
27
|
+
|
|
28
|
+
2. Load the current spec file. Perform a structured ambiguity & coverage scan using this taxonomy. For each category, mark status: Clear / Partial / Missing. Produce an internal coverage map used for prioritization (do not output raw map unless no questions will be asked).
|
|
29
|
+
|
|
30
|
+
Functional Scope & Behavior:
|
|
31
|
+
- Core user goals & success criteria
|
|
32
|
+
- Explicit out-of-scope declarations
|
|
33
|
+
- User roles / personas differentiation
|
|
34
|
+
|
|
35
|
+
Domain & Data Model:
|
|
36
|
+
- Entities, attributes, relationships
|
|
37
|
+
- Identity & uniqueness rules
|
|
38
|
+
- Lifecycle/state transitions
|
|
39
|
+
- Data volume / scale assumptions
|
|
40
|
+
|
|
41
|
+
Interaction & UX Flow:
|
|
42
|
+
- Critical user journeys / sequences
|
|
43
|
+
- Error/empty/loading states
|
|
44
|
+
- Accessibility or localization notes
|
|
45
|
+
|
|
46
|
+
Non-Functional Quality Attributes:
|
|
47
|
+
- Performance (latency, throughput targets)
|
|
48
|
+
- Scalability (horizontal/vertical, limits)
|
|
49
|
+
- Reliability & availability (uptime, recovery expectations)
|
|
50
|
+
- Observability (logging, metrics, tracing signals)
|
|
51
|
+
- Security & privacy (authN/Z, data protection, threat assumptions)
|
|
52
|
+
- Compliance / regulatory constraints (if any)
|
|
53
|
+
|
|
54
|
+
Integration & External Dependencies:
|
|
55
|
+
- External services/APIs and failure modes
|
|
56
|
+
- Data import/export formats
|
|
57
|
+
- Protocol/versioning assumptions
|
|
58
|
+
|
|
59
|
+
Edge Cases & Failure Handling:
|
|
60
|
+
- Negative scenarios
|
|
61
|
+
- Rate limiting / throttling
|
|
62
|
+
- Conflict resolution (e.g., concurrent edits)
|
|
63
|
+
|
|
64
|
+
Constraints & Tradeoffs:
|
|
65
|
+
- Technical constraints (language, storage, hosting)
|
|
66
|
+
- Explicit tradeoffs or rejected alternatives
|
|
67
|
+
|
|
68
|
+
Terminology & Consistency:
|
|
69
|
+
- Canonical glossary terms
|
|
70
|
+
- Avoided synonyms / deprecated terms
|
|
71
|
+
|
|
72
|
+
Completion Signals:
|
|
73
|
+
- Acceptance criteria testability
|
|
74
|
+
- Measurable Definition of Done style indicators
|
|
75
|
+
|
|
76
|
+
Misc / Placeholders:
|
|
77
|
+
- TODO markers / unresolved decisions
|
|
78
|
+
- Ambiguous adjectives ("robust", "intuitive") lacking quantification
|
|
79
|
+
|
|
80
|
+
For each category with Partial or Missing status, add a candidate question opportunity unless:
|
|
81
|
+
- Clarification would not materially change implementation or validation strategy
|
|
82
|
+
- Information is better deferred to planning phase (note internally)
|
|
83
|
+
|
|
84
|
+
3. Generate (internally) a prioritized queue of candidate clarification questions (maximum 5). Do NOT output them all at once. Apply these constraints:
|
|
85
|
+
- Maximum of 10 total questions across the whole session.
|
|
86
|
+
- Each question must be answerable with EITHER:
|
|
87
|
+
- A short multiple‑choice selection (2–5 distinct, mutually exclusive options), OR
|
|
88
|
+
- A one-word / short‑phrase answer (explicitly constrain: "Answer in <=5 words").
|
|
89
|
+
- Only include questions whose answers materially impact architecture, data modeling, task decomposition, test design, UX behavior, operational readiness, or compliance validation.
|
|
90
|
+
- Ensure category coverage balance: attempt to cover the highest impact unresolved categories first; avoid asking two low-impact questions when a single high-impact area (e.g., security posture) is unresolved.
|
|
91
|
+
- Exclude questions already answered, trivial stylistic preferences, or plan-level execution details (unless blocking correctness).
|
|
92
|
+
- Favor clarifications that reduce downstream rework risk or prevent misaligned acceptance tests.
|
|
93
|
+
- If more than 5 categories remain unresolved, select the top 5 by (Impact * Uncertainty) heuristic.
|
|
94
|
+
|
|
95
|
+
4. Sequential questioning loop (interactive):
|
|
96
|
+
- Present EXACTLY ONE question at a time.
|
|
97
|
+
- For multiple‑choice questions:
|
|
98
|
+
- **Analyze all options** and determine the **most suitable option** based on:
|
|
99
|
+
- Best practices for the project type
|
|
100
|
+
- Common patterns in similar implementations
|
|
101
|
+
- Risk reduction (security, performance, maintainability)
|
|
102
|
+
- Alignment with any explicit project goals or constraints visible in the spec
|
|
103
|
+
- Present your **recommended option prominently** at the top with clear reasoning (1-2 sentences explaining why this is the best choice).
|
|
104
|
+
- Format as: `**Recommended:** Option [X] - <reasoning>`
|
|
105
|
+
- Then render all options as a Markdown table:
|
|
106
|
+
|
|
107
|
+
| Option | Description |
|
|
108
|
+
|--------|-------------|
|
|
109
|
+
| A | <Option A description> |
|
|
110
|
+
| B | <Option B description> |
|
|
111
|
+
| C | <Option C description> (add D/E as needed up to 5) |
|
|
112
|
+
| Short | Provide a different short answer (<=5 words) (Include only if free-form alternative is appropriate) |
|
|
113
|
+
|
|
114
|
+
- After the table, add: `You can reply with the option letter (e.g., "A"), accept the recommendation by saying "yes" or "recommended", or provide your own short answer.`
|
|
115
|
+
- For short‑answer style (no meaningful discrete options):
|
|
116
|
+
- Provide your **suggested answer** based on best practices and context.
|
|
117
|
+
- Format as: `**Suggested:** <your proposed answer> - <brief reasoning>`
|
|
118
|
+
- Then output: `Format: Short answer (<=5 words). You can accept the suggestion by saying "yes" or "suggested", or provide your own answer.`
|
|
119
|
+
- After the user answers:
|
|
120
|
+
- If the user replies with "yes", "recommended", or "suggested", use your previously stated recommendation/suggestion as the answer.
|
|
121
|
+
- Otherwise, validate the answer maps to one option or fits the <=5 word constraint.
|
|
122
|
+
- If ambiguous, ask for a quick disambiguation (count still belongs to same question; do not advance).
|
|
123
|
+
- Once satisfactory, record it in working memory (do not yet write to disk) and move to the next queued question.
|
|
124
|
+
- Stop asking further questions when:
|
|
125
|
+
- All critical ambiguities resolved early (remaining queued items become unnecessary), OR
|
|
126
|
+
- User signals completion ("done", "good", "no more"), OR
|
|
127
|
+
- You reach 5 asked questions.
|
|
128
|
+
- Never reveal future queued questions in advance.
|
|
129
|
+
- If no valid questions exist at start, immediately report no critical ambiguities.
|
|
130
|
+
|
|
131
|
+
5. Integration after EACH accepted answer (incremental update approach):
|
|
132
|
+
- Maintain in-memory representation of the spec (loaded once at start) plus the raw file contents.
|
|
133
|
+
- For the first integrated answer in this session:
|
|
134
|
+
- Ensure a `## Clarifications` section exists (create it just after the highest-level contextual/overview section per the spec template if missing).
|
|
135
|
+
- Under it, create (if not present) a `### Session YYYY-MM-DD` subheading for today.
|
|
136
|
+
- Append a bullet line immediately after acceptance: `- Q: <question> → A: <final answer>`.
|
|
137
|
+
- Then immediately apply the clarification to the most appropriate section(s):
|
|
138
|
+
- Functional ambiguity → Update or add a bullet in Functional Requirements.
|
|
139
|
+
- User interaction / actor distinction → Update User Stories or Actors subsection (if present) with clarified role, constraint, or scenario.
|
|
140
|
+
- Data shape / entities → Update Data Model (add fields, types, relationships) preserving ordering; note added constraints succinctly.
|
|
141
|
+
- Non-functional constraint → Add/modify measurable criteria in Non-Functional / Quality Attributes section (convert vague adjective to metric or explicit target).
|
|
142
|
+
- Edge case / negative flow → Add a new bullet under Edge Cases / Error Handling (or create such subsection if template provides placeholder for it).
|
|
143
|
+
- Terminology conflict → Normalize term across spec; retain original only if necessary by adding `(formerly referred to as "X")` once.
|
|
144
|
+
- If the clarification invalidates an earlier ambiguous statement, replace that statement instead of duplicating; leave no obsolete contradictory text.
|
|
145
|
+
- Save the spec file AFTER each integration to minimize risk of context loss (atomic overwrite).
|
|
146
|
+
- Preserve formatting: do not reorder unrelated sections; keep heading hierarchy intact.
|
|
147
|
+
- Keep each inserted clarification minimal and testable (avoid narrative drift).
|
|
148
|
+
|
|
149
|
+
6. Validation (performed after EACH write plus final pass):
|
|
150
|
+
- Clarifications session contains exactly one bullet per accepted answer (no duplicates).
|
|
151
|
+
- Total asked (accepted) questions ≤ 5.
|
|
152
|
+
- Updated sections contain no lingering vague placeholders the new answer was meant to resolve.
|
|
153
|
+
- No contradictory earlier statement remains (scan for now-invalid alternative choices removed).
|
|
154
|
+
- Markdown structure valid; only allowed new headings: `## Clarifications`, `### Session YYYY-MM-DD`.
|
|
155
|
+
- Terminology consistency: same canonical term used across all updated sections.
|
|
156
|
+
|
|
157
|
+
7. Write the updated spec back to `FEATURE_SPEC`.
|
|
158
|
+
|
|
159
|
+
8. Report completion (after questioning loop ends or early termination):
|
|
160
|
+
- Number of questions asked & answered.
|
|
161
|
+
- Path to updated spec.
|
|
162
|
+
- Sections touched (list names).
|
|
163
|
+
- Coverage summary table listing each taxonomy category with Status: Resolved (was Partial/Missing and addressed), Deferred (exceeds question quota or better suited for planning), Clear (already sufficient), Outstanding (still Partial/Missing but low impact).
|
|
164
|
+
- If any Outstanding or Deferred remain, recommend whether to proceed to `/speckit.plan` or run `/speckit.clarify` again later post-plan.
|
|
165
|
+
- Suggested next command.
|
|
166
|
+
|
|
167
|
+
Behavior rules:
|
|
168
|
+
|
|
169
|
+
- If clarifications reveal complex unknowns, flag for research phase
|
|
170
|
+
- If no meaningful ambiguities found (or all potential questions would be low-impact), respond: "No critical ambiguities detected worth formal clarification." and suggest proceeding.
|
|
171
|
+
- If spec file missing, instruct user to run `/speckit.specify` first (do not create a new spec here).
|
|
172
|
+
- Never exceed 5 total asked questions (clarification retries for a single question do not count as new questions).
|
|
173
|
+
- Avoid speculative tech stack questions unless the absence blocks functional clarity.
|
|
174
|
+
- Respect user early termination signals ("stop", "done", "proceed").
|
|
175
|
+
- If no questions asked due to full coverage, output a compact coverage summary (all categories Clear) then suggest advancing.
|
|
176
|
+
- If quota reached with unresolved high-impact categories remaining, explicitly flag them under Deferred with rationale.
|
|
177
|
+
|
|
178
|
+
Context for prioritization: $ARGUMENTS
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Create or update the project constitution from interactive or provided principle inputs, ensuring all dependent templates stay in sync
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
## User Input
|
|
6
|
+
|
|
7
|
+
```text
|
|
8
|
+
$ARGUMENTS
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
You **MUST** consider the user input before proceeding (if not empty).
|
|
12
|
+
|
|
13
|
+
## Outline
|
|
14
|
+
|
|
15
|
+
You are updating the project constitution at `.specify/memory/constitution.md`. This file is a TEMPLATE containing placeholder tokens in square brackets (e.g. `[PROJECT_NAME]`, `[PRINCIPLE_1_NAME]`). Your job is to (a) collect/derive concrete values, (b) fill the template precisely, and (c) propagate any amendments across dependent artifacts.
|
|
16
|
+
|
|
17
|
+
Follow this execution flow:
|
|
18
|
+
|
|
19
|
+
1. Load the existing constitution template at `.specify/memory/constitution.md`.
|
|
20
|
+
- Identify every placeholder token of the form `[ALL_CAPS_IDENTIFIER]`.
|
|
21
|
+
**IMPORTANT**: The user might require less or more principles than the ones used in the template. If a number is specified, respect that - follow the general template. You will update the doc accordingly.
|
|
22
|
+
|
|
23
|
+
2. Collect/derive values for placeholders:
|
|
24
|
+
- If user input (conversation) supplies a value, use it.
|
|
25
|
+
- Otherwise infer from existing repo context (README, docs, prior constitution versions if embedded).
|
|
26
|
+
- For governance dates: `RATIFICATION_DATE` is the original adoption date (if unknown ask or mark TODO), `LAST_AMENDED_DATE` is today if changes are made, otherwise keep previous.
|
|
27
|
+
- `CONSTITUTION_VERSION` must increment according to semantic versioning rules:
|
|
28
|
+
- MAJOR: Backward incompatible governance/principle removals or redefinitions.
|
|
29
|
+
- MINOR: New principle/section added or materially expanded guidance.
|
|
30
|
+
- PATCH: Clarifications, wording, typo fixes, non-semantic refinements.
|
|
31
|
+
- If version bump type ambiguous, propose reasoning before finalizing.
|
|
32
|
+
|
|
33
|
+
3. Draft the updated constitution content:
|
|
34
|
+
- Replace every placeholder with concrete text (no bracketed tokens left except intentionally retained template slots that the project has chosen not to define yet—explicitly justify any left).
|
|
35
|
+
- Preserve heading hierarchy and comments can be removed once replaced unless they still add clarifying guidance.
|
|
36
|
+
- Ensure each Principle section: succinct name line, paragraph (or bullet list) capturing non‑negotiable rules, explicit rationale if not obvious.
|
|
37
|
+
- Ensure Governance section lists amendment procedure, versioning policy, and compliance review expectations.
|
|
38
|
+
|
|
39
|
+
4. Consistency propagation checklist (convert prior checklist into active validations):
|
|
40
|
+
- Read `.specify/templates/plan-template.md` and ensure any "Constitution Check" or rules align with updated principles.
|
|
41
|
+
- Read `.specify/templates/spec-template.md` for scope/requirements alignment—update if constitution adds/removes mandatory sections or constraints.
|
|
42
|
+
- Read `.specify/templates/tasks-template.md` and ensure task categorization reflects new or removed principle-driven task types (e.g., observability, versioning, testing discipline).
|
|
43
|
+
- Read each command file in `.specify/templates/commands/*.md` (including this one) to verify no outdated references (agent-specific names like CLAUDE only) remain when generic guidance is required.
|
|
44
|
+
- Read any runtime guidance docs (e.g., `README.md`, `docs/quickstart.md`, or agent-specific guidance files if present). Update references to principles changed.
|
|
45
|
+
|
|
46
|
+
5. Produce a Sync Impact Report (prepend as an HTML comment at top of the constitution file after update):
|
|
47
|
+
- Version change: old → new
|
|
48
|
+
- List of modified principles (old title → new title if renamed)
|
|
49
|
+
- Added sections
|
|
50
|
+
- Removed sections
|
|
51
|
+
- Templates requiring updates (✅ updated / ⚠ pending) with file paths
|
|
52
|
+
- Follow-up TODOs if any placeholders intentionally deferred.
|
|
53
|
+
|
|
54
|
+
6. Validation before final output:
|
|
55
|
+
- No remaining unexplained bracket tokens.
|
|
56
|
+
- Version line matches report.
|
|
57
|
+
- Dates ISO format YYYY-MM-DD.
|
|
58
|
+
- Principles are declarative, testable, and free of vague language ("should" → replace with MUST/SHOULD rationale where appropriate).
|
|
59
|
+
|
|
60
|
+
7. Write the completed constitution back to `.specify/memory/constitution.md` (overwrite).
|
|
61
|
+
|
|
62
|
+
8. Output a final summary to the user with:
|
|
63
|
+
- New version and bump rationale.
|
|
64
|
+
- Any files flagged for manual follow-up.
|
|
65
|
+
- Suggested commit message (e.g., `docs: amend constitution to vX.Y.Z (principle additions + governance update)`).
|
|
66
|
+
|
|
67
|
+
Formatting & Style Requirements:
|
|
68
|
+
|
|
69
|
+
- Use Markdown headings exactly as in the template (do not demote/promote levels).
|
|
70
|
+
- Wrap long rationale lines to keep readability (<100 chars ideally) but do not hard enforce with awkward breaks.
|
|
71
|
+
- Keep a single blank line between sections.
|
|
72
|
+
- Avoid trailing whitespace.
|
|
73
|
+
|
|
74
|
+
If the user supplies partial updates (e.g., only one principle revision), still perform validation and version decision steps.
|
|
75
|
+
|
|
76
|
+
If critical info missing (e.g., ratification date truly unknown), insert `TODO(<FIELD_NAME>): explanation` and include in the Sync Impact Report under deferred items.
|
|
77
|
+
|
|
78
|
+
Do not create a new template; always operate on the existing `.specify/memory/constitution.md` file.
|