codexspec 0.7.8__tar.gz → 0.7.9__tar.gz
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.
- {codexspec-0.7.8 → codexspec-0.7.9}/PKG-INFO +23 -12
- {codexspec-0.7.8 → codexspec-0.7.9}/README.md +22 -11
- {codexspec-0.7.8 → codexspec-0.7.9}/pyproject.toml +1 -1
- {codexspec-0.7.8 → codexspec-0.7.9}/src/codexspec/__init__.py +1 -1
- {codexspec-0.7.8 → codexspec-0.7.9}/src/codexspec/commands/installer.py +18 -4
- {codexspec-0.7.8 → codexspec-0.7.9}/src/codexspec/integrations/codex.py +1 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/analyze.md +9 -4
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/generate-spec.md +2 -2
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/implement-tasks.md +6 -2
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/plan-to-tasks.md +3 -0
- codexspec-0.7.9/templates/commands/review-design.md +132 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/review-plan.md +8 -6
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/review-tasks.md +6 -5
- codexspec-0.7.9/templates/commands/spec-to-design.md +114 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/spec-to-plan.md +24 -21
- codexspec-0.7.9/templates/docs/design-template.md +95 -0
- codexspec-0.7.9/templates/docs/plan-template-detailed.md +101 -0
- codexspec-0.7.9/templates/docs/plan-template-simple.md +53 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/translations/de.json +2 -2
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/translations/en.json +2 -2
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/translations/es.json +2 -2
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/translations/fr.json +2 -2
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/translations/ja.json +2 -2
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/translations/ko.json +2 -2
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/translations/pt-BR.json +2 -2
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/translations/zh-CN.json +2 -2
- codexspec-0.7.8/templates/docs/plan-template-detailed.md +0 -218
- codexspec-0.7.8/templates/docs/plan-template-simple.md +0 -57
- {codexspec-0.7.8 → codexspec-0.7.9}/.gitignore +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/LICENSE +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/codexspec-icon.svg +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/codexspec-logo-dark.svg +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/codexspec-logo-light.svg +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/scripts/bash/check-i18n-completeness.sh +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/scripts/bash/check-i18n-structure.sh +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/scripts/bash/check-prerequisites.sh +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/scripts/bash/common.sh +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/scripts/bash/create-new-feature.sh +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/scripts/bash/review-context.sh +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/scripts/powershell/check-prerequisites.ps1 +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/scripts/powershell/common.ps1 +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/scripts/powershell/create-new-feature.ps1 +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/scripts/powershell/review-context.ps1 +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/src/codexspec/commands/__init__.py +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/src/codexspec/i18n.py +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/src/codexspec/idea.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/src/codexspec/integrations/__init__.py +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/src/codexspec/integrations/base.py +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/src/codexspec/integrations/claude.py +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/src/codexspec/profile.py +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/src/codexspec/translator.py +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/checklist.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/clarify.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/commit-staged.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/config.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/constitution.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/debug.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/distill.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/evolve.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/pr.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/quick.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/review-code.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/review-spec.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/specify.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/commands/tasks-to-issues.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/docs/checklist-template.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/docs/constitution-template.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/docs/requirements-template.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/docs/spec-template-detailed.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/docs/spec-template-simple.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/docs/tasks-template-detailed.md +0 -0
- {codexspec-0.7.8 → codexspec-0.7.9}/templates/docs/tasks-template-simple.md +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: codexspec
|
|
3
|
-
Version: 0.7.
|
|
3
|
+
Version: 0.7.9
|
|
4
4
|
Summary: CodexSpec - A Requirements-First SDD toolkit for Claude Code
|
|
5
5
|
Project-URL: Homepage, https://github.com/Zts0hg/codexspec
|
|
6
6
|
Project-URL: Repository, https://github.com/Zts0hg/codexspec
|
|
@@ -166,9 +166,12 @@ CodexSpec is built on the belief that **effective AI-assisted development requir
|
|
|
166
166
|
CodexSpec structures development into **reviewable checkpoints**:
|
|
167
167
|
|
|
168
168
|
```
|
|
169
|
-
Idea → /specify
|
|
170
|
-
|
|
171
|
-
|
|
169
|
+
Idea → /specify → requirements.md
|
|
170
|
+
→ /generate-spec → spec.md → review-spec
|
|
171
|
+
→ /spec-to-design → design.md → review-design
|
|
172
|
+
→ /spec-to-plan → plan.md → review-plan
|
|
173
|
+
→ /plan-to-tasks → tasks.md → review-tasks
|
|
174
|
+
→ /implement-tasks → code
|
|
172
175
|
```
|
|
173
176
|
|
|
174
177
|
Confirmed requirements are the highest-priority feature authority. Derived artifacts carry explicit source links so conflicts can be traced back instead of silently propagated.
|
|
@@ -176,6 +179,7 @@ Confirmed requirements are the highest-priority feature authority. Derived artif
|
|
|
176
179
|
**Every generated artifact has a corresponding review command:**
|
|
177
180
|
|
|
178
181
|
- `spec.md` → `/codexspec:review-spec`
|
|
182
|
+
- `design.md` → `/codexspec:review-design`
|
|
179
183
|
- `plan.md` → `/codexspec:review-plan`
|
|
180
184
|
- `tasks.md` → `/codexspec:review-tasks`
|
|
181
185
|
- All artifacts → `/codexspec:analyze`
|
|
@@ -207,6 +211,7 @@ claude
|
|
|
207
211
|
> /codexspec:constitution Create principles focused on code quality and testing
|
|
208
212
|
> /codexspec:specify I want to build a todo application
|
|
209
213
|
> /codexspec:generate-spec
|
|
214
|
+
> /codexspec:spec-to-design
|
|
210
215
|
> /codexspec:spec-to-plan
|
|
211
216
|
> /codexspec:plan-to-tasks
|
|
212
217
|
> /codexspec:implement-tasks
|
|
@@ -355,9 +360,12 @@ The config command will guide you through:
|
|
|
355
360
|
CodexSpec breaks development into **reviewable checkpoints**:
|
|
356
361
|
|
|
357
362
|
```
|
|
358
|
-
Idea → /specify
|
|
359
|
-
|
|
360
|
-
|
|
363
|
+
Idea → /specify → requirements.md
|
|
364
|
+
→ /generate-spec → spec.md → review-spec
|
|
365
|
+
→ /spec-to-design → design.md → review-design
|
|
366
|
+
→ /spec-to-plan → plan.md → review-plan
|
|
367
|
+
→ /plan-to-tasks → tasks.md → review-tasks
|
|
368
|
+
→ /implement-tasks → code
|
|
361
369
|
```
|
|
362
370
|
|
|
363
371
|
### Workflow Steps
|
|
@@ -367,10 +375,11 @@ Idea → /specify → requirements.md → /generate-spec → spec.md → /spec-t
|
|
|
367
375
|
| 1. Project Principles | `/codexspec:constitution` | `constitution.md` | ✅ |
|
|
368
376
|
| 2. Requirement Clarification | `/codexspec:specify` | `requirements.md` | ✅ |
|
|
369
377
|
| 3. Generate Spec | `/codexspec:generate-spec` | `spec.md` + auto-review | ✅ |
|
|
370
|
-
| 4.
|
|
371
|
-
| 5.
|
|
372
|
-
| 6.
|
|
373
|
-
| 7.
|
|
378
|
+
| 4. System Design | `/codexspec:spec-to-design` | `design.md` + auto-review | ✅ |
|
|
379
|
+
| 5. Technical Planning | `/codexspec:spec-to-plan` | `plan.md` + auto-review | ✅ |
|
|
380
|
+
| 6. Task Breakdown | `/codexspec:plan-to-tasks` | `tasks.md` + auto-review | ✅ |
|
|
381
|
+
| 7. Cross-Artifact Analysis | `/codexspec:analyze` | Analysis report | ✅ |
|
|
382
|
+
| 8. Implementation | `/codexspec:implement-tasks` | Code | - |
|
|
374
383
|
|
|
375
384
|
### specify vs clarify: When to Use Which?
|
|
376
385
|
|
|
@@ -568,7 +577,8 @@ Implementation follows **conditional TDD workflow**:
|
|
|
568
577
|
| `/codexspec:constitution` | Create/update project constitution with cross-artifact validation |
|
|
569
578
|
| `/codexspec:specify` | Clarify, confirm, and persist requirements in `requirements.md` |
|
|
570
579
|
| `/codexspec:generate-spec` | Generate `spec.md` document ★ Auto-review |
|
|
571
|
-
| `/codexspec:spec-to-
|
|
580
|
+
| `/codexspec:spec-to-design` | Produce `design.md` (architecture/components/decisions) ★ Auto-review |
|
|
581
|
+
| `/codexspec:spec-to-plan` | Convert design to implementation plan ★ Auto-review |
|
|
572
582
|
| `/codexspec:plan-to-tasks` | Break down plan into traceable, verifiable tasks ★ Auto-review |
|
|
573
583
|
| `/codexspec:implement-tasks` | Execute tasks (conditional TDD) |
|
|
574
584
|
|
|
@@ -577,6 +587,7 @@ Implementation follows **conditional TDD workflow**:
|
|
|
577
587
|
| Command | Description |
|
|
578
588
|
| ------------------------- | -------------------------------------- |
|
|
579
589
|
| `/codexspec:review-spec` | Review specification (auto or manual) |
|
|
590
|
+
| `/codexspec:review-design` | Review design (auto or manual) |
|
|
580
591
|
| `/codexspec:review-plan` | Review technical plan (auto or manual) |
|
|
581
592
|
| `/codexspec:review-tasks` | Review task breakdown (auto or manual) |
|
|
582
593
|
|
|
@@ -121,9 +121,12 @@ CodexSpec is built on the belief that **effective AI-assisted development requir
|
|
|
121
121
|
CodexSpec structures development into **reviewable checkpoints**:
|
|
122
122
|
|
|
123
123
|
```
|
|
124
|
-
Idea → /specify
|
|
125
|
-
|
|
126
|
-
|
|
124
|
+
Idea → /specify → requirements.md
|
|
125
|
+
→ /generate-spec → spec.md → review-spec
|
|
126
|
+
→ /spec-to-design → design.md → review-design
|
|
127
|
+
→ /spec-to-plan → plan.md → review-plan
|
|
128
|
+
→ /plan-to-tasks → tasks.md → review-tasks
|
|
129
|
+
→ /implement-tasks → code
|
|
127
130
|
```
|
|
128
131
|
|
|
129
132
|
Confirmed requirements are the highest-priority feature authority. Derived artifacts carry explicit source links so conflicts can be traced back instead of silently propagated.
|
|
@@ -131,6 +134,7 @@ Confirmed requirements are the highest-priority feature authority. Derived artif
|
|
|
131
134
|
**Every generated artifact has a corresponding review command:**
|
|
132
135
|
|
|
133
136
|
- `spec.md` → `/codexspec:review-spec`
|
|
137
|
+
- `design.md` → `/codexspec:review-design`
|
|
134
138
|
- `plan.md` → `/codexspec:review-plan`
|
|
135
139
|
- `tasks.md` → `/codexspec:review-tasks`
|
|
136
140
|
- All artifacts → `/codexspec:analyze`
|
|
@@ -162,6 +166,7 @@ claude
|
|
|
162
166
|
> /codexspec:constitution Create principles focused on code quality and testing
|
|
163
167
|
> /codexspec:specify I want to build a todo application
|
|
164
168
|
> /codexspec:generate-spec
|
|
169
|
+
> /codexspec:spec-to-design
|
|
165
170
|
> /codexspec:spec-to-plan
|
|
166
171
|
> /codexspec:plan-to-tasks
|
|
167
172
|
> /codexspec:implement-tasks
|
|
@@ -310,9 +315,12 @@ The config command will guide you through:
|
|
|
310
315
|
CodexSpec breaks development into **reviewable checkpoints**:
|
|
311
316
|
|
|
312
317
|
```
|
|
313
|
-
Idea → /specify
|
|
314
|
-
|
|
315
|
-
|
|
318
|
+
Idea → /specify → requirements.md
|
|
319
|
+
→ /generate-spec → spec.md → review-spec
|
|
320
|
+
→ /spec-to-design → design.md → review-design
|
|
321
|
+
→ /spec-to-plan → plan.md → review-plan
|
|
322
|
+
→ /plan-to-tasks → tasks.md → review-tasks
|
|
323
|
+
→ /implement-tasks → code
|
|
316
324
|
```
|
|
317
325
|
|
|
318
326
|
### Workflow Steps
|
|
@@ -322,10 +330,11 @@ Idea → /specify → requirements.md → /generate-spec → spec.md → /spec-t
|
|
|
322
330
|
| 1. Project Principles | `/codexspec:constitution` | `constitution.md` | ✅ |
|
|
323
331
|
| 2. Requirement Clarification | `/codexspec:specify` | `requirements.md` | ✅ |
|
|
324
332
|
| 3. Generate Spec | `/codexspec:generate-spec` | `spec.md` + auto-review | ✅ |
|
|
325
|
-
| 4.
|
|
326
|
-
| 5.
|
|
327
|
-
| 6.
|
|
328
|
-
| 7.
|
|
333
|
+
| 4. System Design | `/codexspec:spec-to-design` | `design.md` + auto-review | ✅ |
|
|
334
|
+
| 5. Technical Planning | `/codexspec:spec-to-plan` | `plan.md` + auto-review | ✅ |
|
|
335
|
+
| 6. Task Breakdown | `/codexspec:plan-to-tasks` | `tasks.md` + auto-review | ✅ |
|
|
336
|
+
| 7. Cross-Artifact Analysis | `/codexspec:analyze` | Analysis report | ✅ |
|
|
337
|
+
| 8. Implementation | `/codexspec:implement-tasks` | Code | - |
|
|
329
338
|
|
|
330
339
|
### specify vs clarify: When to Use Which?
|
|
331
340
|
|
|
@@ -523,7 +532,8 @@ Implementation follows **conditional TDD workflow**:
|
|
|
523
532
|
| `/codexspec:constitution` | Create/update project constitution with cross-artifact validation |
|
|
524
533
|
| `/codexspec:specify` | Clarify, confirm, and persist requirements in `requirements.md` |
|
|
525
534
|
| `/codexspec:generate-spec` | Generate `spec.md` document ★ Auto-review |
|
|
526
|
-
| `/codexspec:spec-to-
|
|
535
|
+
| `/codexspec:spec-to-design` | Produce `design.md` (architecture/components/decisions) ★ Auto-review |
|
|
536
|
+
| `/codexspec:spec-to-plan` | Convert design to implementation plan ★ Auto-review |
|
|
527
537
|
| `/codexspec:plan-to-tasks` | Break down plan into traceable, verifiable tasks ★ Auto-review |
|
|
528
538
|
| `/codexspec:implement-tasks` | Execute tasks (conditional TDD) |
|
|
529
539
|
|
|
@@ -532,6 +542,7 @@ Implementation follows **conditional TDD workflow**:
|
|
|
532
542
|
| Command | Description |
|
|
533
543
|
| ------------------------- | -------------------------------------- |
|
|
534
544
|
| `/codexspec:review-spec` | Review specification (auto or manual) |
|
|
545
|
+
| `/codexspec:review-design` | Review design (auto or manual) |
|
|
535
546
|
| `/codexspec:review-plan` | Review technical plan (auto or manual) |
|
|
536
547
|
| `/codexspec:review-tasks` | Review task breakdown (auto or manual) |
|
|
537
548
|
|
|
@@ -44,7 +44,7 @@ from .profile import ensure_profile_scaffold, inject_profile_block
|
|
|
44
44
|
from .translator import SUPPORTED_LANGUAGES, translate
|
|
45
45
|
|
|
46
46
|
# Version info
|
|
47
|
-
__version__ = "0.7.
|
|
47
|
+
__version__ = "0.7.9"
|
|
48
48
|
__author__ = "CodexSpec Team"
|
|
49
49
|
|
|
50
50
|
# Constitution file path constants
|
|
@@ -47,11 +47,11 @@ def get_commands_metadata() -> list[CommandMetadata]:
|
|
|
47
47
|
|
|
48
48
|
Returns:
|
|
49
49
|
List of CommandMetadata dictionaries sorted by category priority:
|
|
50
|
-
core (
|
|
51
|
-
Total:
|
|
50
|
+
core (11) -> enhanced (7) -> git (2) -> review (1) -> utility (2)
|
|
51
|
+
Total: 23 commands
|
|
52
52
|
"""
|
|
53
53
|
return [
|
|
54
|
-
# Core Commands (
|
|
54
|
+
# Core Commands (11)
|
|
55
55
|
{
|
|
56
56
|
"name": "constitution",
|
|
57
57
|
"display_name": "/codexspec:constitution",
|
|
@@ -73,10 +73,17 @@ def get_commands_metadata() -> list[CommandMetadata]:
|
|
|
73
73
|
"category": "core",
|
|
74
74
|
"file_name": "generate-spec.md",
|
|
75
75
|
},
|
|
76
|
+
{
|
|
77
|
+
"name": "spec-to-design",
|
|
78
|
+
"display_name": "/codexspec:spec-to-design",
|
|
79
|
+
"description": "将已确认的规格转换为可追溯的设计文档(架构/组件/关键设计决策)",
|
|
80
|
+
"category": "core",
|
|
81
|
+
"file_name": "spec-to-design.md",
|
|
82
|
+
},
|
|
76
83
|
{
|
|
77
84
|
"name": "spec-to-plan",
|
|
78
85
|
"display_name": "/codexspec:spec-to-plan",
|
|
79
|
-
"description": "
|
|
86
|
+
"description": "将已确认的设计转换为可追溯的实现计划",
|
|
80
87
|
"category": "core",
|
|
81
88
|
"file_name": "spec-to-plan.md",
|
|
82
89
|
},
|
|
@@ -94,6 +101,13 @@ def get_commands_metadata() -> list[CommandMetadata]:
|
|
|
94
101
|
"category": "core",
|
|
95
102
|
"file_name": "review-spec.md",
|
|
96
103
|
},
|
|
104
|
+
{
|
|
105
|
+
"name": "review-design",
|
|
106
|
+
"display_name": "/codexspec:review-design",
|
|
107
|
+
"description": "审查设计的忠实度、可行性与规划就绪度",
|
|
108
|
+
"category": "core",
|
|
109
|
+
"file_name": "review-design.md",
|
|
110
|
+
},
|
|
97
111
|
{
|
|
98
112
|
"name": "review-plan",
|
|
99
113
|
"display_name": "/codexspec:review-plan",
|
|
@@ -115,6 +115,7 @@ Use these Codex skills when working on CodexSpec workflows:
|
|
|
115
115
|
- `$codexspec:constitution` to create or update project principles.
|
|
116
116
|
- `$codexspec:specify` to capture confirmed requirements.
|
|
117
117
|
- `$codexspec:generate-spec` to produce `spec.md`.
|
|
118
|
+
- `$codexspec:spec-to-design` to produce `design.md`.
|
|
118
119
|
- `$codexspec:spec-to-plan` to produce `plan.md`.
|
|
119
120
|
- `$codexspec:plan-to-tasks` to produce `tasks.md`.
|
|
120
121
|
- `$codexspec:implement-tasks` to implement approved tasks.
|
|
@@ -22,7 +22,7 @@ Converse in the interaction language and author artifacts in the document langua
|
|
|
22
22
|
|
|
23
23
|
This command detects cross-artifact inconsistencies **and auto-remediates them**. It is not read-only.
|
|
24
24
|
|
|
25
|
-
- `requirements.md` is the single source of truth. analyze **never modifies `requirements.md`**. Every fix conforms the downstream artifacts (`spec.md`, `plan.md`, `tasks.md`) to `requirements.md`; the fix direction is uniquely determined by the authority hierarchy (requirements > spec > plan > tasks) and never requires inventing intent.
|
|
25
|
+
- `requirements.md` is the single source of truth. analyze **never modifies `requirements.md`**. Every fix conforms the downstream artifacts (`spec.md`, `design.md`, `plan.md`, `tasks.md`) to `requirements.md`; the fix direction is uniquely determined by the authority hierarchy (requirements > spec > design > plan > tasks) and never requires inventing intent.
|
|
26
26
|
- Auto-apply deterministic, authority-directed fixes **by default** — both when invoked manually and when invoked inside the `auto_next` chain — with no confirmation prompt and no human-escalation path.
|
|
27
27
|
|
|
28
28
|
Resolve the feature by explicit path, then current branch. Ask the user if it is ambiguous; never select the latest feature silently.
|
|
@@ -33,10 +33,13 @@ Load:
|
|
|
33
33
|
|
|
34
34
|
- `requirements.md`
|
|
35
35
|
- `spec.md`
|
|
36
|
+
- `design.md`
|
|
36
37
|
- `plan.md`
|
|
37
38
|
- `tasks.md`
|
|
38
39
|
- Constitution
|
|
39
40
|
|
|
41
|
+
A legacy feature may have no `design.md`; when it is absent, analyze the chain without the design link and proceed.
|
|
42
|
+
|
|
40
43
|
Legacy compatibility: if `requirements.md` is missing, state that the analysis starts at `spec.md` and cannot validate fidelity to the original discussion. In legacy mode there is no source of truth to conform to, so do not auto-modify artifacts; report findings only.
|
|
41
44
|
|
|
42
45
|
## End-to-End Traceability
|
|
@@ -46,7 +49,8 @@ Build the chain:
|
|
|
46
49
|
```text
|
|
47
50
|
confirmed NEED/CON/DEC/OUT
|
|
48
51
|
-> REQ/NFR Sources
|
|
49
|
-
->
|
|
52
|
+
-> design Covers
|
|
53
|
+
-> plan Covers (Covers: REQ; Design: <component>)
|
|
50
54
|
-> task Covers + Plan reference
|
|
51
55
|
```
|
|
52
56
|
|
|
@@ -54,7 +58,8 @@ Detect:
|
|
|
54
58
|
|
|
55
59
|
- Confirmed requirements with no spec coverage
|
|
56
60
|
- Spec requirements with missing or invalid sources
|
|
57
|
-
- Spec requirements with no
|
|
61
|
+
- Spec requirements with no design coverage
|
|
62
|
+
- Design components with no plan coverage
|
|
58
63
|
- Plan deliverables with no task coverage
|
|
59
64
|
- Tasks with no upstream authority or implementation-support justification
|
|
60
65
|
- Semantic drift, scope expansion, contradictions, and use of superseded/open entries
|
|
@@ -89,7 +94,7 @@ Produce:
|
|
|
89
94
|
|
|
90
95
|
- Authority mode
|
|
91
96
|
- End-to-end coverage table
|
|
92
|
-
- Applied remediations: the exact downstream edits made to `spec.md`/`plan.md`/`tasks.md` and why, or "none"
|
|
97
|
+
- Applied remediations: the exact downstream edits made to `spec.md`/`design.md`/`plan.md`/`tasks.md` and why, or "none"
|
|
93
98
|
- Verified defects by severity that were not auto-remediable (for example, a reported-only tie-break conflict)
|
|
94
99
|
- Unmapped or unauthorized items
|
|
95
100
|
- Risk Advisories
|
|
@@ -101,8 +101,8 @@ Read `workflow.auto_next` from `.codexspec/config.yml` (default `false`; only th
|
|
|
101
101
|
|
|
102
102
|
When `workflow.auto_next` is `true` AND the Automatic Review Loop above concluded in a passing state — the final Overall Status is `PASS` or `PASS_WITH_WARNINGS` — advance the chain automatically:
|
|
103
103
|
|
|
104
|
-
1. Emit exactly one notice line, in the interaction language, e.g. `auto_next: review passed → invoking /codexspec:spec-to-
|
|
105
|
-
2. Invoke `/codexspec:spec-to-
|
|
104
|
+
1. Emit exactly one notice line, in the interaction language, e.g. `auto_next: review passed → invoking /codexspec:spec-to-design <feature-dir>`.
|
|
105
|
+
2. Invoke `/codexspec:spec-to-design <feature-dir>` exactly once, then end this command.
|
|
106
106
|
|
|
107
107
|
Do not auto-advance when `workflow.auto_next` is disabled, or the review loop stopped at `NEEDS_REVISION` or `BLOCKED`, or stopped early per the conditions above; in those cases hand control back to the user exactly as the review loop already does. This advances the chain and does not modify the Output Summary.
|
|
108
108
|
|
|
@@ -37,6 +37,7 @@ Read:
|
|
|
37
37
|
|
|
38
38
|
- `requirements.md`
|
|
39
39
|
- `spec.md`
|
|
40
|
+
- `design.md`
|
|
40
41
|
- `plan.md`
|
|
41
42
|
- `tasks.md`
|
|
42
43
|
- `.codexspec/memory/constitution.md` when present
|
|
@@ -46,8 +47,11 @@ Authority order:
|
|
|
46
47
|
1. Confirmed entries in `requirements.md`
|
|
47
48
|
2. `spec.md`
|
|
48
49
|
3. Constitution and verified repository facts
|
|
49
|
-
4.
|
|
50
|
-
5. `
|
|
50
|
+
4. `design.md`
|
|
51
|
+
5. Approved `plan.md`
|
|
52
|
+
6. `tasks.md`
|
|
53
|
+
|
|
54
|
+
A legacy feature may have no `design.md`; when it is absent, proceed with `plan.md` as the design-and-plan authority.
|
|
51
55
|
|
|
52
56
|
When `requirements.md` is absent, use legacy spec-only mode. Treat `spec.md` as
|
|
53
57
|
the temporary highest feature authority and state that fidelity to the original
|
|
@@ -33,9 +33,12 @@ Read:
|
|
|
33
33
|
|
|
34
34
|
- `requirements.md`
|
|
35
35
|
- `spec.md`
|
|
36
|
+
- `design.md`
|
|
36
37
|
- `plan.md`
|
|
37
38
|
- Constitution and relevant repository conventions
|
|
38
39
|
|
|
40
|
+
`design.md` (the confirmed design) sits between `spec.md` and `plan.md` in authority; read it as context so tasks trace to the design the plan implements. A legacy feature may have no `design.md`; proceed from `plan.md` in that case.
|
|
41
|
+
|
|
39
42
|
Legacy compatibility: when `requirements.md` is absent, use `spec.md` as the temporary highest authority and state the limitation.
|
|
40
43
|
|
|
41
44
|
## Stop Conditions
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Review design fidelity, feasibility, and planning readiness
|
|
3
|
+
argument-hint: "[design.md or feature directory]"
|
|
4
|
+
handoffs:
|
|
5
|
+
- agent: claude
|
|
6
|
+
step: Review design against confirmed requirements, spec, and repository facts
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Design Reviewer
|
|
10
|
+
|
|
11
|
+
## Language Preference
|
|
12
|
+
|
|
13
|
+
Read `.codexspec/config.yml`. Two independent language controls apply (each falls back to `language.output`, then English):
|
|
14
|
+
|
|
15
|
+
- **Interaction language** (`language.interaction`): language for all conversation with the user — questions, explanations, status messages, and `codexspec` CLI terminal output.
|
|
16
|
+
- **Document language** (`language.document`): language for generated artifact files (requirements/spec/plan/tasks).
|
|
17
|
+
|
|
18
|
+
Converse in the interaction language and author artifacts in the document language. Apply the project's translation standard to both: translate by meaning (not word-for-word), keep English for terms with no good native equivalent, and write as if originally in that language.
|
|
19
|
+
|
|
20
|
+
## User Input
|
|
21
|
+
|
|
22
|
+
`$ARGUMENTS`
|
|
23
|
+
|
|
24
|
+
## Review Authority
|
|
25
|
+
|
|
26
|
+
Resolve by explicit path, then current branch; never silently select the latest feature.
|
|
27
|
+
|
|
28
|
+
Read `requirements.md`, `spec.md`, `design.md`, the constitution, and only the repository files necessary to verify design claims.
|
|
29
|
+
|
|
30
|
+
If `requirements.md` is absent, use legacy spec-only mode and disclose that original-discussion fidelity cannot be verified.
|
|
31
|
+
|
|
32
|
+
Authority order:
|
|
33
|
+
|
|
34
|
+
1. Confirmed requirements
|
|
35
|
+
2. Specification
|
|
36
|
+
3. Constitution and verified repository facts
|
|
37
|
+
4. Design-level technical decisions
|
|
38
|
+
5. Applicable best practices
|
|
39
|
+
|
|
40
|
+
## Review Passes
|
|
41
|
+
|
|
42
|
+
### 1. Fidelity and Coverage
|
|
43
|
+
|
|
44
|
+
- Verify every `REQ`/`NFR` has design coverage.
|
|
45
|
+
- Verify each component, interface, data change, and design decision has `Covers:`.
|
|
46
|
+
- Detect omitted behavior, semantic changes, scope expansion, and design decisions that override confirmed trade-offs.
|
|
47
|
+
- Verify design-level assumptions remain labeled and do not become product requirements.
|
|
48
|
+
|
|
49
|
+
### 2. Feasibility and Internal Quality
|
|
50
|
+
|
|
51
|
+
Report evidence-backed defects such as:
|
|
52
|
+
|
|
53
|
+
- Referencing nonexistent modules, APIs, paths, or capabilities
|
|
54
|
+
- Contradictory component responsibilities or interfaces
|
|
55
|
+
- Missing design decisions that genuinely block planning
|
|
56
|
+
- Invalid data, compatibility, security, or interface assumptions
|
|
57
|
+
- Complexity that creates concrete risk without serving a confirmed requirement
|
|
58
|
+
|
|
59
|
+
Data models, API contracts, sequence diagrams, cross-cutting design sections, and explicit interfaces are required only when the feature or repository context makes them necessary.
|
|
60
|
+
|
|
61
|
+
### 3. Advisories
|
|
62
|
+
|
|
63
|
+
Put optional best practices in **Risk Advisories** or **Design Opportunities**. Include applicability, actual risk or benefit, and relationship to the user goal.
|
|
64
|
+
|
|
65
|
+
Advisories do not affect status, do not affect the score, and must not be auto-fixed.
|
|
66
|
+
|
|
67
|
+
## Finding Validation
|
|
68
|
+
|
|
69
|
+
Every defect must include:
|
|
70
|
+
|
|
71
|
+
- **Evidence**
|
|
72
|
+
- **Location**
|
|
73
|
+
- **Mismatch**
|
|
74
|
+
- **Impact**
|
|
75
|
+
- **Remediation**
|
|
76
|
+
|
|
77
|
+
Merge findings with the same root cause. Do not deduct the same root cause under alignment, architecture, and decision-record planning separately.
|
|
78
|
+
|
|
79
|
+
Reject findings that are only stylistic preference, generic best practice without applicability, or a demand to replace a confirmed trade-off.
|
|
80
|
+
|
|
81
|
+
Zero verified defects is a valid result.
|
|
82
|
+
|
|
83
|
+
## Severity, Status, and Compatibility Score
|
|
84
|
+
|
|
85
|
+
- Critical: blocks a correct or feasible implementation
|
|
86
|
+
- Warning: likely incorrect implementation or major rework
|
|
87
|
+
- Minor: localized verified defect
|
|
88
|
+
- Advisory: optional and non-scoring
|
|
89
|
+
|
|
90
|
+
Status:
|
|
91
|
+
|
|
92
|
+
- Critical present: `BLOCKED`
|
|
93
|
+
- Warning present without Critical: `NEEDS_REVISION`
|
|
94
|
+
- Minor only: `PASS_WITH_WARNINGS`
|
|
95
|
+
- No defects: `PASS`
|
|
96
|
+
|
|
97
|
+
Compatibility Score:
|
|
98
|
+
|
|
99
|
+
- No defects: `100`
|
|
100
|
+
- Minor only: `max(80, 100 - 3 × Minor)`
|
|
101
|
+
- Warning present: `max(50, 79 - 8 × (Warning - 1) - 3 × Minor)`
|
|
102
|
+
- Critical present: `max(0, 49 - 15 × (Critical - 1) - 8 × Warning - 3 × Minor)`
|
|
103
|
+
|
|
104
|
+
Advisory does not affect the score. There are no fixed deductions for omitted template sections.
|
|
105
|
+
|
|
106
|
+
## Report
|
|
107
|
+
|
|
108
|
+
Save `<feature-dir>/review-design.md`:
|
|
109
|
+
|
|
110
|
+
```markdown
|
|
111
|
+
# Design Review Report
|
|
112
|
+
|
|
113
|
+
## Summary
|
|
114
|
+
- **Overall Status**: PASS / PASS_WITH_WARNINGS / NEEDS_REVISION / BLOCKED
|
|
115
|
+
- **Compatibility Score**: X/100
|
|
116
|
+
- **Authority Mode**: Requirements-first / Legacy spec-only
|
|
117
|
+
- **Readiness**: Ready for Planning / Revision Required
|
|
118
|
+
|
|
119
|
+
## Requirement Coverage
|
|
120
|
+
| Requirement | Design Reference | Result |
|
|
121
|
+
|
|
122
|
+
## Verified Defects
|
|
123
|
+
### Critical
|
|
124
|
+
### Warnings
|
|
125
|
+
### Minor
|
|
126
|
+
|
|
127
|
+
## Risk Advisories
|
|
128
|
+
|
|
129
|
+
## Design Opportunities
|
|
130
|
+
|
|
131
|
+
## Score Derivation
|
|
132
|
+
```
|
|
@@ -25,25 +25,27 @@ Converse in the interaction language and author artifacts in the document langua
|
|
|
25
25
|
|
|
26
26
|
Resolve by explicit path, then current branch; never silently select the latest feature.
|
|
27
27
|
|
|
28
|
-
Read `requirements.md`, `spec.md`, `plan.md`, the constitution, and only the repository files necessary to verify plan claims.
|
|
28
|
+
Read `requirements.md`, `spec.md`, `design.md`, `plan.md`, the constitution, and only the repository files necessary to verify plan claims.
|
|
29
29
|
|
|
30
|
-
If `requirements.md` is absent, use legacy spec-only mode and disclose that original-discussion fidelity cannot be verified.
|
|
30
|
+
If `requirements.md` is absent, use legacy spec-only mode and disclose that original-discussion fidelity cannot be verified. A legacy feature may also have no `design.md`; when it is absent, review the plan against the spec directly.
|
|
31
31
|
|
|
32
32
|
Authority order:
|
|
33
33
|
|
|
34
34
|
1. Confirmed requirements
|
|
35
35
|
2. Specification
|
|
36
36
|
3. Constitution and verified repository facts
|
|
37
|
-
4.
|
|
38
|
-
5.
|
|
37
|
+
4. `design.md`
|
|
38
|
+
5. Plan-level technical decisions
|
|
39
|
+
6. Applicable best practices
|
|
39
40
|
|
|
40
41
|
## Review Passes
|
|
41
42
|
|
|
42
43
|
### 1. Fidelity and Coverage
|
|
43
44
|
|
|
44
45
|
- Verify every `REQ`/`NFR` has plan coverage.
|
|
45
|
-
- Verify
|
|
46
|
-
-
|
|
46
|
+
- Verify the plan covers the confirmed `design.md` components (which cover the requirements) and does not restate or re-architect the design — architecture/interface/data-model decisions belong to `design.md`, not the plan.
|
|
47
|
+
- Verify each plan component or phase carries `Covers: REQ-xxx; Design: <design component>` (or `Covers: REQ-xxx` for a legacy feature with no `design.md`).
|
|
48
|
+
- Detect omitted behavior, semantic changes, scope expansion, and plan decisions that override confirmed trade-offs or the confirmed design.
|
|
47
49
|
- Verify plan-level assumptions remain labeled and do not become product requirements.
|
|
48
50
|
|
|
49
51
|
### 2. Feasibility and Internal Quality
|
|
@@ -25,18 +25,19 @@ Converse in the interaction language and author artifacts in the document langua
|
|
|
25
25
|
|
|
26
26
|
Resolve by explicit path, then current branch; never silently select the latest feature.
|
|
27
27
|
|
|
28
|
-
Read `requirements.md`, `spec.md`, `plan.md`, `tasks.md`, the constitution, and relevant repository paths.
|
|
28
|
+
Read `requirements.md`, `spec.md`, `design.md`, `plan.md`, `tasks.md`, the constitution, and relevant repository paths.
|
|
29
29
|
|
|
30
|
-
If `requirements.md` is absent, use legacy spec-only mode and disclose that original-discussion fidelity cannot be verified.
|
|
30
|
+
If `requirements.md` is absent, use legacy spec-only mode and disclose that original-discussion fidelity cannot be verified. A legacy feature may also have no `design.md`; when it is absent, proceed without the design link.
|
|
31
31
|
|
|
32
32
|
Authority order:
|
|
33
33
|
|
|
34
34
|
1. Confirmed requirements
|
|
35
35
|
2. Specification
|
|
36
36
|
3. Constitution and verified repository facts
|
|
37
|
-
4.
|
|
38
|
-
5.
|
|
39
|
-
6.
|
|
37
|
+
4. `design.md`
|
|
38
|
+
5. Approved plan
|
|
39
|
+
6. Task list
|
|
40
|
+
7. Applicable best practices
|
|
40
41
|
|
|
41
42
|
## Review Passes
|
|
42
43
|
|