Skip to content

Commit 22a8dad

Browse files
committed
docs(commands): fix stale path refs, phantom phase, duplicate numbering
Four small doc corrections in templates/commands/*.md, surfaced while integrating Spec Kit into a Claude Code project: - plan.md: "Command ends after Phase 2 planning" referenced a phase that doesn't exist in this file. Only Phase 0 (research) and Phase 1 (data-model, contracts, quickstart) are defined; the command actually ends after Phase 1. Updated the terminal step to match. - implement.md: step 5 "Task phases" parse-list was "Setup, Tests, Core, Integration, Polish" — an older layered taxonomy that doesn't match what tasks.md currently emits ("Setup, Foundational, User Stories in priority order, Polish"). The mismatch meant /speckit.implement wouldn't find any of the phase headers it was looking for. Aligned the parse list with tasks.md's actual output. - constitution.md: step 4 instructed the user to "Read each command file in .specify/templates/commands/*.md" — that path isn't materialized on every integration install (e.g., Claude Code puts command files under .claude/skills/speckit-*/SKILL.md; Copilot uses .github/prompts/). Softened the reference to name the likely integration-specific locations and note the path varies. - taskstoissues.md: four consecutive `1.` source-level numbered items in the Outline block. Markdown auto-renumbers on render, but the source reads oddly and encourages the same pattern in new specs. Renumbered to 1/2/3/4. All four reproduce on main as of this branch-off; none touch behavior beyond what each docstring already describes. ## AI disclosure This PR was drafted with assistance from Claude (Opus 4.7) while integrating Spec Kit into a live project. The rationale for each fix came from actually running the affected commands end-to-end through an agent; the one-line edits are mechanical corrections to existing text, not new guidance.
1 parent c118c1c commit 22a8dad

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

templates/commands/constitution.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Follow this execution flow:
8080
- Read `.specify/templates/plan-template.md` and ensure any "Constitution Check" or rules align with updated principles.
8181
- Read `.specify/templates/spec-template.md` for scope/requirements alignment—update if constitution adds/removes mandatory sections or constraints.
8282
- Read `.specify/templates/tasks-template.md` and ensure task categorization reflects new or removed principle-driven task types (e.g., observability, versioning, testing discipline).
83-
- 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.
83+
- Review each installed command file to verify no outdated references (agent-specific names like CLAUDE only) remain when generic guidance is required. Paths vary by integration — e.g. `.claude/skills/speckit-*/SKILL.md` (Claude Code), `.github/prompts/speckit.*.prompt.md` (Copilot), or `.specify/templates/commands/*.md` when a preset ships them. Consult the active integration's skills/commands directory rather than assuming a single location.
8484
- Read any runtime guidance docs (e.g., `README.md`, `docs/quickstart.md`, or agent-specific guidance files if present). Update references to principles changed.
8585
8686
5. Produce a Sync Impact Report (prepend as an HTML comment at top of the constitution file after update):

templates/commands/implement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ You **MUST** consider the user input before proceeding (if not empty).
135135
- **Kubernetes/k8s**: `*.secret.yaml`, `secrets/`, `.kube/`, `kubeconfig*`, `*.key`, `*.crt`
136136
137137
5. Parse tasks.md structure and extract:
138-
- **Task phases**: Setup, Tests, Core, Integration, Polish
138+
- **Task phases**: Setup, Foundational, User Stories (one phase per story, in priority order), Polish (matches the phase structure emitted by `/speckit.tasks`; see `templates/commands/tasks.md`)
139139
- **Task dependencies**: Sequential vs parallel execution rules
140140
- **Task details**: ID, description, file paths, parallel markers [P]
141141
- **Execution flow**: Order and dependency requirements

templates/commands/plan.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ You **MUST** consider the user input before proceeding (if not empty).
7070
- Phase 1: Update agent context by running the agent script
7171
- Re-evaluate Constitution Check post-design
7272
73-
4. **Stop and report**: Command ends after Phase 2 planning. Report branch, IMPL_PLAN path, and generated artifacts.
73+
4. **Stop and report**: Command ends after Phase 1 (data-model & contracts). Report branch, IMPL_PLAN path, and generated artifacts.
7474
7575
5. **Check for extension hooks**: After reporting, check if `.specify/extensions.yml` exists in the project root.
7676
- If it exists, read it and look for entries under the `hooks.after_plan` key

templates/commands/taskstoissues.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ You **MUST** consider the user input before proceeding (if not empty).
5151
## Outline
5252
5353
1. Run `{SCRIPT}` from repo root and parse FEATURE_DIR and AVAILABLE_DOCS list. All paths must be absolute. 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").
54-
1. From the executed script, extract the path to **tasks**.
55-
1. Get the Git remote by running:
54+
2. From the executed script, extract the path to **tasks**.
55+
3. Get the Git remote by running:
5656
5757
```bash
5858
git config --get remote.origin.url
@@ -61,7 +61,7 @@ git config --get remote.origin.url
6161
> [!CAUTION]
6262
> ONLY PROCEED TO NEXT STEPS IF THE REMOTE IS A GITHUB URL
6363
64-
1. For each task in the list, use the GitHub MCP server to create a new issue in the repository that is representative of the Git remote.
64+
4. For each task in the list, use the GitHub MCP server to create a new issue in the repository that is representative of the Git remote.
6565

6666
> [!CAUTION]
6767
> UNDER NO CIRCUMSTANCES EVER CREATE ISSUES IN REPOSITORIES THAT DO NOT MATCH THE REMOTE URL

0 commit comments

Comments
 (0)