Files
spec-kit/templates/commands/converge.md
T
0c29d890ab feat: add /speckit.converge command (#3001)
* Add /speckit.converge SDD artifacts and project scaffolding

Dogfood the converge feature through Spec Kit's own workflow:

- spec.md, plan.md, tasks.md, research, data-model, contracts, quickstart
- requirements checklist for the feature
- ratified constitution v1.0.0 (.specify/memory)
- Specify project scaffolding (.specify/, .github agent + prompt files)

Defines a built-in /speckit.converge command that assesses spec/plan/tasks
against the codebase and appends remaining work as new tasks (no git, no
change tracking, append-only). Implementation not yet started.

Excludes unrelated working-tree changes to agents.py, extensions.py,
test_extensions.py, catalog.community.json, and README.md.

* Implement /speckit.converge command

Add the built-in converge command that assesses the codebase against a
feature's spec.md, plan.md, and tasks.md and appends remaining unbuilt work
as new traceable tasks to tasks.md (append-only; no git, no change tracking).

- templates/commands/converge.md: full command body (load artifacts, assess
  code, classify findings missing/partial/contradicts/unrequested, append
  '## Phase N — Convergence' tasks with source-ref + gap-type, read-only
  guardrails, converged branch, handoff, before/after_converge hooks)
- Register converge as a core command across all enumeration sites
  (SKILL_DESCRIPTIONS, _FALLBACK_CORE_COMMAND_NAMES, ARGUMENT_HINTS, and the
  integration test command lists incl. copilot/generic file inventories)
- init.py Next Steps panel + README Core Commands table
- tasks.md: T001-T024 complete (T025 manual quickstart pending)

Full suite green: 2343 passed.

* Record quickstart validation results for /speckit.converge (T025)

All six quickstart scenarios validated (GitHub Copilot agent, macOS/zsh):
S1 gap->appended traceable task, S2 implement+re-converge, S3 converged leaves
tasks.md unchanged, S4 read-only boundaries, S5 missing-prereq stop, S6 cross-
integration install (copilot + windsurf). Automated suite: 2343 passed.

* Record 2026-06-16 re-verification results for /speckit.converge (T025)

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Fix integration upgrade deleting settings.json and dropping script +x

Two upgrade-path bugs surfaced during converge E2E validation:

- copilot upgrade stale-deleted .vscode/settings.json because setup() only tracks the file when it creates it; on upgrade the pre-existing file is merged and left untracked, so Phase 2 stale cleanup removed it. Add an integration-level stale_cleanup_exclusions() hook (CopilotIntegration returns {.vscode/settings.json}) and subtract it from stale_keys.

- shared .specify/scripts/*.sh lost their execute bit because the managed refresh rewrites them with the bundled source mode (often 0o644) and nothing restored perms. Call ensure_executable_scripts() after the managed-refresh block (POSIX only).

Add regression tests in TestIntegrationUpgrade covering both fixes (validated to fail without the fixes).

* fix: resolve markdownlint errors in PR files

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* chore: clean up runtime state files from PR

Remove .specify state files that are per-project runtime artifacts:
- feature.json, init-options.json, integration.json
- manifest files, extension registry, bug artifacts

These are generated by 'specify init' and should not be committed.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* feat: fold converge artifacts from #3003 and #3005

- Add speckit.converge Copilot agent and prompt files (#3003)
- Add regression test for Claude argument hints (#3005)
- Remove invalid converge entry from Claude argument hints
- Fix documentation removing branch-prefix fallback claims

Supersedes: #3003, #3005

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* chore: remove non-converge specify scaffolding from PR

Remove .specify/ artifacts, non-converge .github/agents and prompts,
and copilot-instructions.md that were generated by 'specify init'
and are not part of the converge command feature.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* chore: remove SDD spec artifacts from PR

Remove specs/001-converge-command/ — the spec/plan/tasks/research SDD
artifacts produced while building this feature. spec-kit does not track
a specs/ directory on main (those are outputs of running the workflow on
the repo, not part of the shipped tool).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* chore: remove generated Copilot converge command files

Remove .github/agents/speckit.converge.agent.md and
.github/prompts/speckit.converge.prompt.md — these are generated by
'specify init --integration copilot' from templates/commands/converge.md
(all __SPECKIT_COMMAND_*__/{SCRIPT} tokens are resolved). main tracks no
.github/agents or .github/prompts files; the template is the source of truth.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* chore: split out unrelated integration-upgrade fix

Move the stale_cleanup_exclusions / executable-bit upgrade fix
(base.py, copilot, _migrate_commands.py, test_integration_subcommand.py)
out of this PR into its own change. This PR is now scoped purely to the
/speckit.converge command.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix: add converge to core command template ordering

converge is a core command in SKILL_DESCRIPTIONS but was missing from
_CORE_COMMAND_TEMPLATE_ORDER, so it sorted with the fallback rank. Add it
after 'implement' to keep core-command ordering consistent across
integrations.

Addresses review feedback on #3001.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* docs: make converge findings example neutral

Replace the self-referential sample evidence text in the Convergence
Findings table with a neutral placeholder so agents are less likely to copy
nonsensical template-specific findings into real output.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* docs: clarify converge scope and hook outcome wording

- Remove FR-specific parenthetical from code-scope rule so it doesn't imply
  a hard FR-001 reference exists in every feature
- Replace unsupported 'pass outcome to hook context' instruction with explicit
  in-session outcome reporting before hook listing

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* docs: align converge task example with tasks format

Use  (no colon) in the convergence task example so it
matches tasks-template formatting and downstream expectations.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Clarification of usage

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* docs: align converge phase/task-id format with tasks template

- Use  (colon) for consistency with tasks template
- Clarify appended task IDs must be zero-padded ( style)
- Update checklist example to a concrete zero-padded ID ()

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* docs: standardize converge phase heading format

Use  consistently in converge.md (including the
append-only contract section) to match Step 7 and tasks template style.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-17 14:47:00 -05:00

11 KiB

description, scripts
description scripts
Assess the current codebase against the feature's spec, plan, and tasks, then append any remaining unbuilt work as new tasks to tasks.md so implement can complete it.
sh ps
scripts/bash/check-prerequisites.sh --json --require-tasks --include-tasks scripts/powershell/check-prerequisites.ps1 -Json -RequireTasks -IncludeTasks

User Input

$ARGUMENTS

You MUST consider the user input before proceeding (if not empty).

Pre-Execution Checks

Check for extension hooks (before convergence):

  • Check if .specify/extensions.yml exists in the project root.

  • If it exists, read it and look for entries under the hooks.before_converge key

  • If the YAML cannot be parsed or is invalid, skip hook checking silently and continue normally

  • Filter out hooks where enabled is explicitly false. Treat hooks without an enabled field as enabled by default.

  • For each remaining hook, do not attempt to interpret or evaluate hook condition expressions:

    • If the hook has no condition field, or it is null/empty, treat the hook as executable
    • If the hook defines a non-empty condition, skip the hook and leave condition evaluation to the HookExecutor implementation
  • For each executable hook, output the following based on its optional flag:

    • Optional hook (optional: true):

      ## Extension Hooks
      
      **Optional Pre-Hook**: {extension}
      Command: `/{command}`
      Description: {description}
      
      Prompt: {prompt}
      To execute: `/{command}`
      
    • Mandatory hook (optional: false):

      ## Extension Hooks
      
      **Automatic Pre-Hook**: {extension}
      Executing: `/{command}`
      EXECUTE_COMMAND: {command}
      
      Wait for the result of the hook command before proceeding to the Goal.
      
  • If no hooks are registered or .specify/extensions.yml does not exist, skip silently

Goal

Close the gap between what a feature's specification, plan, and tasks call for and what the codebase currently implements. Read spec.md, plan.md, and tasks.md as the sole source of intent (with the constitution as governing constraints), assess the current state of the code, determine which requirements, acceptance criteria, plan decisions, and existing tasks are unmet, incomplete, or only partially satisfied, and append each piece of remaining work as a new, traceable task at the bottom of tasks.md so that __SPECKIT_COMMAND_IMPLEMENT__ can complete it. This command MUST run only after __SPECKIT_COMMAND_IMPLEMENT__ has run on the current tasks.md, and after __SPECKIT_COMMAND_TASKS__ has produced a complete tasks.md.

This is not a diff tool and does not track changes. It assesses the present state of the code relative to the feature's artifacts — no git, no branch comparison, no history.

Operating Constraints

APPEND-ONLY, NEVER REWRITE: The command's only write is appending a new ## Phase N: Convergence section to tasks.md. It MUST NOT:

  • modify spec.md or plan.md in any way;
  • rewrite, renumber, reorder, or delete any existing task (including tasks from a prior Convergence phase);
  • modify, create, or delete any application code — completing the appended tasks is the job of __SPECKIT_COMMAND_IMPLEMENT__.

When the codebase already satisfies everything, the command MUST leave tasks.md byte-for-byte unchanged (no empty Convergence header) and report a clean result.

Constitution Authority: The project constitution (/memory/constitution.md) is non-negotiable. Code that violates a MUST principle is the highest-severity finding and produces a corresponding remediation task. If the constitution is an unfilled template, skip constitution checks gracefully rather than failing.

Execution Steps

1. Initialize Convergence Context

Run {SCRIPT} once from repo root and parse JSON for FEATURE_DIR and AVAILABLE_DOCS. Derive absolute paths:

  • SPEC = FEATURE_DIR/spec.md
  • PLAN = FEATURE_DIR/plan.md
  • TASKS = FEATURE_DIR/tasks.md
  • CONSTITUTION = /memory/constitution.md (if present) If spec.md, plan.md, or tasks.md is missing, STOP with a clear, actionable message naming the prerequisite command to run (__SPECKIT_COMMAND_SPECIFY__ for a missing spec, __SPECKIT_COMMAND_PLAN__ for a missing plan, __SPECKIT_COMMAND_TASKS__ for missing tasks). Do not produce partial output. 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").

2. Load Artifacts (Progressive Disclosure)

Load only the minimal necessary context from each artifact:

From spec.md:

  • Functional Requirements (FR-###)
  • Success Criteria (SC-###) — include only items requiring buildable work; exclude post-launch outcome metrics and business KPIs
  • User Stories and their Acceptance Scenarios
  • Edge Cases (if present)

From plan.md:

  • Architecture/stack choices and technical decisions
  • Data Model references
  • Phases and named touch-points (files/components the plan says will be created or edited)
  • Technical constraints

From tasks.md:

  • Task IDs (to compute the next ID and next phase number)
  • Descriptions, phase grouping, and referenced file paths

From constitution (if not an unfilled template):

  • Principle names and MUST/SHOULD normative statements

3. Build the Intent Inventory

Create an internal model (do not echo raw artifacts):

  • Requirements inventory: one stable key per FR-### / SC-### / user-story acceptance scenario (e.g. US1/AC2), plus the plan decisions and constitution principles that impose buildable obligations.
  • Code-scope map: from the file paths named in plan.md and tasks.md, plus a keyword search for the concepts each requirement describes, derive the set of source files and components in scope for assessment. Bound the assessment to these — do not infer scope beyond what the artifacts define.

4. Assess the Codebase and Classify Findings

For each item in the intent inventory, inspect the current code in scope and produce a Finding only where there is a gap. Classify every finding by gap type:

  • missing: the required work is absent from the code entirely.
  • partial: the work exists but does not yet fully satisfy the requirement / acceptance criterion / plan decision.
  • contradicts: the code does something that conflicts with stated intent or a constitution MUST principle.
  • unrequested: the code contains work not called for by the spec, plan, or tasks (surfaced for awareness — converge does not delete code, it only appends a task to review/justify or remove it).

Each Finding records: a stable id, the source-ref it traces to, the gap-type, a severity, and a short human-readable description with the evidence (the file/area observed).

Edge cases:

  • Little or no code yet: treat the entire specified scope as missing remaining work rather than failing.
  • Nothing remains: produce zero findings and follow the converged branch in Step 7.

5. Assign Severity

  • CRITICAL: violates a constitution MUST principle, or a missing/contradicts gap that blocks baseline functionality of a P1 user story.
  • HIGH: a missing or partial gap on a core functional requirement or acceptance criterion.
  • MEDIUM: a partial gap on a secondary requirement, or an unrequested addition with unclear justification.
  • LOW: minor partial gaps, polish, or low-risk unrequested additions.

6. Present the In-Session Findings Summary

Before appending anything, output a compact, severity-graded summary (no file writes yet):

Convergence Findings

ID Gap Type Severity Source Evidence Remaining Work
F1 missing HIGH FR-008 Example: no append-only guard detected in path/to/module.py when writing tasks.md Add append-only enforcement

Summary metrics:

  • Requirements / acceptance criteria checked
  • Plan decisions checked
  • Constitution principles checked (or "skipped — template")
  • Findings by gap type (missing / partial / contradicts / unrequested)
  • Findings by severity

7. Append Convergence Tasks (or report converged)

If there are one or more actionable findings (tasks_appended outcome):

Append to the end of tasks.md, per the append contract:

  1. Scan all existing task IDs; let M be the maximum. Determine the next phase number N (highest existing phase + 1).

  2. Write a single new section header ## Phase N: Convergence.

  3. Emit one checklist item per actionable finding, ordered CRITICAL/HIGH first, assigning zero-padded IDs T{M+1:03d}, T{M+2:03d}, …:

    - [ ] T042 <imperative description> per <source-ref> (<gap-type>)
    

    <source-ref> traces the task to its origin: e.g. FR-003, SC-002, US1/AC2, plan: storage decision, Constitution II.

    <gap-type> is one of missing, partial, contradicts, unrequested.

    Constitution-violation tasks MUST be emitted first and described as CRITICAL.

  4. Never reuse or renumber existing IDs. If a prior Convergence phase exists, add a new, separately-numbered one below it — do not touch the old one.

If there are no actionable findings (converged outcome):

  • Do not modify tasks.md at all — no empty phase header.
  • Report: "✅ Converged — the implementation satisfies the spec, plan, and tasks."
  • Include the summary counts of what was checked.

8. Provide Next Actions (Handoff)

  • On tasks_appended: state how many tasks were appended under which phase, and recommend running __SPECKIT_COMMAND_IMPLEMENT__ to complete them; note that a follow-up converge run will find fewer or no remaining items.
  • On converged: recommend proceeding to review / opening a PR. No further implement pass is needed for this feature's specified scope.

9. Check for extension hooks

After producing the result, check if .specify/extensions.yml exists in the project root.

  • If it exists, read it and look for entries under the hooks.after_converge key

  • If the YAML cannot be parsed or is invalid, skip hook checking silently and continue normally

  • Filter out hooks where enabled is explicitly false. Treat hooks without an enabled field as enabled by default.

  • For each remaining hook, do not attempt to interpret or evaluate hook condition expressions:

    • If the hook has no condition field, or it is null/empty, treat the hook as executable
    • If the hook defines a non-empty condition, skip the hook and leave condition evaluation to the HookExecutor implementation
  • Report the convergence outcome (converged or tasks_appended) in-session before listing any hooks, so users can decide whether to run optional follow-up commands.

  • For each executable hook, output the following based on its optional flag:

    • Optional hook (optional: true):

      ## Extension Hooks
      
      **Optional Hook**: {extension}
      Command: `/{command}`
      Description: {description}
      
      Prompt: {prompt}
      To execute: `/{command}`
      
    • Mandatory hook (optional: false):

      ## Extension Hooks
      
      **Automatic Hook**: {extension}
      Executing: `/{command}`
      EXECUTE_COMMAND: {command}
      
  • If no hooks are registered or .specify/extensions.yml does not exist, skip silently