Skip to content

fix(plan): keep quickstart output out of implementation scope#2805

Merged
mnriem merged 1 commit into
github:mainfrom
WOLIKIMCHENG:fix/quickstart-validation-guide-scope
Jun 3, 2026
Merged

fix(plan): keep quickstart output out of implementation scope#2805
mnriem merged 1 commit into
github:mainfrom
WOLIKIMCHENG:fix/quickstart-validation-guide-scope

Conversation

@WOLIKIMCHENG
Copy link
Copy Markdown
Contributor

Description

Clarifies that /speckit.plan should generate quickstart.md as a validation scenarios / run guide artifact, not as a place for full implementation code.

The updated prompt now asks for runnable validation scenarios, prerequisites, commands, and expected outcomes, while explicitly excluding full implementation code, model/service/controller bodies, migrations, and complete test suites.

Fixes #1400

Testing

  • .venv/bin/python -m pytest tests/integrations/test_integration_generic.py::TestGenericIntegration::test_plan_defines_quickstart_as_validation_guide -q -p no:cacheprovider
  • .venv/bin/python -m pytest tests/integrations/test_integration_generic.py -q -p no:cacheprovider
  • git diff --check -- templates/commands/plan.md tests/integrations/test_integration_generic.py

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR clarifies the intent of /speckit.plan so that quickstart.md is generated as a validation/run guide artifact (scenarios, prerequisites, commands, expected outcomes) rather than containing full implementation code. This aligns the plan output with the intended phased workflow (design/validation guidance first, implementation later via tasks.md).

Changes:

  • Update the speckit.plan command template to explicitly define quickstart.md as a runnable validation guide and explicitly exclude implementation code/migrations/full test suites.
  • Add an integration test asserting the generated speckit.plan.md includes the new quickstart guidance wording.
Show a summary per file
File Description
templates/commands/plan.md Adds explicit quickstart validation guide instructions and excludes implementation scope in the plan prompt.
tests/integrations/test_integration_generic.py Adds regression coverage to ensure the generated plan command keeps quickstart out of implementation scope.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 2/2 changed files
  • Comments generated: 0

@mnriem mnriem merged commit 6d511ac into github:main Jun 3, 2026
11 checks passed
@mnriem
Copy link
Copy Markdown
Collaborator

mnriem commented Jun 3, 2026

Thank you!

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.

Quickstart.md gets full implementation of app code

3 participants