fix(plan): keep quickstart output out of implementation scope#2805
Open
WOLIKIMCHENG wants to merge 1 commit into
Open
fix(plan): keep quickstart output out of implementation scope#2805WOLIKIMCHENG wants to merge 1 commit into
WOLIKIMCHENG wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
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.plancommand template to explicitly definequickstart.mdas a runnable validation guide and explicitly exclude implementation code/migrations/full test suites. - Add an integration test asserting the generated
speckit.plan.mdincludes 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Clarifies that
/speckit.planshould generatequickstart.mdas 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:cacheprovidergit diff --check -- templates/commands/plan.md tests/integrations/test_integration_generic.py