docs: distinguish extension reconciliation from core SDD by mnriem · Pull Request #4948 · github/spec-kit · GitHub
Skip to content

docs: distinguish extension reconciliation from core SDD - #4948

Merged
mnriem merged 5 commits into
github:mainfrom
mnriem:docs/extension-reconciliation-boundary
Oct 13, 2026
Merged

mnriem merged 5 commits into
github:mainfrom
mnriem:docs/extension-reconciliation-boundary

Conversation

@mnriem

@mnriem mnriem commented Oct 13, 2026

Copy link
Copy Markdown
Collaborator

Description

Follow-up to #4945.

Clarify that reconciliation of spec.md, plan.md, and tasks.md is never performed by the core Spec Kit workflow:

  • /speckit.analyze reports inconsistencies without editing artifacts.
  • /speckit.converge remains append-only and can only add missing implementation work to tasks.md.
  • Teams may reconcile artifacts directly, and extensions may provide commands or hooks that reconcile them during or after delivery according to the extension's documented behavior and project governance.
  • Reconciliation timing remains separate from persistence, which describes how the team maintains artifacts after delivery.

This updates the persistence concept, evolving-specs guide, and extension reference consistently. It does not change command, template, hook, or extension behavior.

Testing

  • git diff --check — passed.

  • npx --yes markdownlint-cli2 docs/concepts/spec-persistence.md docs/guides/evolving-specs.md docs/reference/extensions.md — passed; three files linted, zero issues.

  • CLI checks, pytest, and sample-project execution were not run because this change only updates documentation.

  • Tested locally with uv run specify --help

  • Ran existing tests with uv sync && uv run pytest

  • Tested with a sample project (if applicable)

AI Disclosure

  • I did not use AI assistance for this contribution
  • I did use AI assistance (fill in the disclosure below)

AI disclosure: Authored by GitHub Copilot on behalf of @mnriem using GPT-5.6 Sol (model ID: gpt-5.6-sol), with session-default reasoning settings. The agent autonomously authored the documentation and PR text and ran validation in an interactive session at the user's direction; no human line-by-line review is claimed. AI assistance covered documentation assessment, edits, validation, and commit/PR preparation.

Clarify that core commands never reconcile feature artifacts while teams and extensions may provide reconciliation during or after delivery. Keep that behavior separate from post-delivery persistence.

Assisted-by: GitHub Copilot (model: GPT-5.6 Sol, autonomous)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 423e8bf6-30ec-49e3-bdb5-dc073f812ee5
Copilot AI balanced review requested due to automatic review settings October 13, 2026 14:48

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The new wording obscures artifact-owning core commands’ documented remediation role and uses inconsistent timing terminology.

3 open findings
What changed in this PR

Clarifies that artifact reconciliation is team- or extension-owned rather than an automatic core workflow responsibility.

Changes:

  • Documents analyze and converge boundaries.
  • Separates reconciliation timing from persistence.
  • Describes extension-provided reconciliation.
File Description
docs/​concepts/​spec-persistence.md Refines reconciliation and persistence concepts.
docs/​guides/​evolving-specs.md Updates practical artifact-evolution guidance.
docs/​reference/​extensions.md Documents extension reconciliation capabilities.

🧠 Review effort: Balanced


💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/concepts/spec-persistence.md Outdated
Comment thread docs/concepts/spec-persistence.md Outdated
Comment thread docs/guides/evolving-specs.md Outdated
Clarify that core lacks an automatic all-artifact reconciler while contributors can rerun the command that owns each artifact. Use consistent during-delivery timing terminology.

Assisted-by: GitHub Copilot (model: GPT-5.6 Sol, autonomous)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 423e8bf6-30ec-49e3-bdb5-dc073f812ee5
@mnriem

mnriem commented Oct 13, 2026 •

Copy link
Copy Markdown
Collaborator Author

Addressed all findings from review 5505462186 in commit 5674098a:

  • Replaced the blanket statement that core never reconciles artifacts with the narrower boundary that core has no dedicated automatic all-artifact reconciler.
  • Preserved the documented remediation path through the artifact-owning commands: /speckit.specify or /speckit.clarify, /speckit.plan, and /speckit.tasks.
  • Kept /speckit.analyze read-only and /speckit.converge append-only.
  • Standardized reconciliation timing as “during delivery.”
  • Clarified that teams and extensions can coordinate broader reconciliation without changing core command responsibilities.

Validation: git diff --check passed; focused markdownlint passed with zero issues.

AI disclosure: This review-round response and the documentation changes were generated by GitHub Copilot on behalf of @mnriem using GPT-5.6 Sol (model ID: gpt-5.6-sol), session-default reasoning settings, autonomous mode. AI assistance covered review assessment, documentation edits, validation, commit creation, and this summary.

Copilot AI balanced review requested due to automatic review settings October 13, 2026 14:57

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Converge’s contract is incorrectly narrowed to missing implementation work.

1 open finding
3 resolved since last review

🧠 Review effort: Balanced

Comment thread docs/concepts/spec-persistence.md Outdated
Use the established remaining-work wording so converge coverage includes missing, partial, contradictory, and unrequested implementation outcomes.

Assisted-by: GitHub Copilot (model: GPT-5.6 Sol, autonomous)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 423e8bf6-30ec-49e3-bdb5-dc073f812ee5
Copilot AI balanced review requested due to automatic review settings October 13, 2026 15:02
@mnriem

mnriem commented Oct 13, 2026

Copy link
Copy Markdown
Collaborator Author

Addressed review 5505603643 in commit f9c66a69.

Changed “missing implementation work” to the established “remaining work” wording. This preserves converge’s full documented scope, including tasks arising from missing, partial, contradictory, or unrequested implementation—not only work that is absent.

Validation: git diff --check passed; focused markdownlint passed with zero issues.

AI disclosure: This review-round response and documentation correction were generated by GitHub Copilot on behalf of @mnriem using GPT-5.6 Sol (model ID: gpt-5.6-sol), session-default reasoning settings, autonomous mode. AI assistance covered review assessment, the wording correction, validation, commit creation, and this summary.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The guide incorrectly presents /speckit.specify as suitable for revising an existing specification.

0 open findings

1 resolved since last review
Previously missed (1)

In code that hasn't changed since last review

Low severity Correct guidance: use clarify or edit spec.md for existing features

docs/​guides/​evolving-specs.md:52

This presents /speckit.specify as a way to revise or regenerate the current spec, but that command always creates a feature directory and copies a fresh spec template (templates/commands/specify.md:94-111). For an existing feature, readers should use /speckit.clarify or edit spec.md directly; otherwise following this reconciliation guidance can create a second feature or overwrite the current spec.

🧠 Review effort: Balanced

Retain specify as an existing-spec update path while documenting that callers must target the existing SPECIFY_FEATURE_DIRECTORY to avoid creating a new feature directory.

Assisted-by: GitHub Copilot (model: GPT-5.6 Sol, autonomous)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 423e8bf6-30ec-49e3-bdb5-dc073f812ee5
Copilot AI balanced review requested due to automatic review settings October 13, 2026 15:15
@mnriem

mnriem commented Oct 13, 2026

Copy link
Copy Markdown
Collaborator Author

Assessed review 5505692404 against the actual command and clarified the guidance in commit acb75d48.

/speckit.specify does support updating an existing specification: templates/commands/specify.md describes it as “Create or update,” gives an explicitly supplied SPECIFY_FEATURE_DIRECTORY precedence, and writes the generated specification to that directory’s spec.md. docs/reference/agentic-sdd.md likewise directs users back to /speckit.specify for requirement problems.

The review identified a valid usage caveat rather than an invalid update path. The guide now says to target the existing SPECIFY_FEATURE_DIRECTORY when using /speckit.specify for revision and warns that omitting that explicit existing directory creates a new feature directory. /speckit.clarify remains the incremental-edit alternative.

Validation: git diff --check passed; focused markdownlint passed with zero issues.

AI disclosure: This assessment, documentation clarification, and review-round response were generated by GitHub Copilot on behalf of @mnriem using GPT-5.6 Sol (model ID: gpt-5.6-sol), session-default reasoning settings, autonomous mode. AI assistance covered command inspection, review assessment, documentation editing, validation, commit creation, and this summary.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The guide presents /speckit.specify as incremental revision despite its replacement behavior for existing specs.

1 open finding

🧠 Review effort: Balanced

Comment thread docs/guides/evolving-specs.md Outdated
Remove artifact-command rerun prescriptions from persistence guidance. Leave reconciliation to documented team conventions or extensions while retaining analyze and converge boundaries.

Assisted-by: GitHub Copilot (model: GPT-5.6 Sol, autonomous)
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 423e8bf6-30ec-49e3-bdb5-dc073f812ee5
Copilot AI balanced review requested due to automatic review settings October 13, 2026 15:30
@mnriem

mnriem commented Oct 13, 2026

Copy link
Copy Markdown
Collaborator Author

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation consistently reflects existing core command and extension behavior.

0 open findings

1 resolved since last review

🧠 Review effort: Balanced

@mnriem
mnriem merged commit fe3de81 into github:main Oct 13, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants