Skip to content

Commit 6d511ac

Browse files
WOLIKIMCHENGroot
andauthored
fix(plan): clarify quickstart validation guide scope (#2805)
Co-authored-by: root <kinsonnee@gmail.com>
1 parent 06c7653 commit 6d511ac

2 files changed

Lines changed: 22 additions & 1 deletion

File tree

templates/commands/plan.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,14 @@ Command ends after Phase 2 planning. Report branch, IMPL_PLAN path, and generate
147147
- Examples: public APIs for libraries, command schemas for CLI tools, endpoints for web services, grammars for parsers, UI contracts for applications
148148
- Skip if project is purely internal (build scripts, one-off tools, etc.)
149149

150-
3. **Agent context update**:
150+
3. **Create quickstart validation guide**`quickstart.md`:
151+
- Document runnable validation scenarios that prove the feature works end-to-end
152+
- Include prerequisites, setup commands, test/run commands, and expected outcomes
153+
- Use links or references to contracts and data model details instead of duplicating them
154+
- Do not include full implementation code, model/service/controller bodies, migrations, or complete test suites
155+
- Keep this artifact as a validation/run guide; implementation details belong in `tasks.md` and the implementation phase
156+
157+
4. **Agent context update**:
151158
- Update the plan reference between the `<!-- SPECKIT START -->` and `<!-- SPECKIT END -->` markers in `__CONTEXT_FILE__` to point to the plan file created in step 1 (the IMPL_PLAN path)
152159

153160
**Output**: data-model.md, /contracts/*, quickstart.md, updated agent context file

tests/integrations/test_integration_generic.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,20 @@ def test_plan_references_correct_context_file(self, tmp_path):
185185
)
186186
assert "__CONTEXT_FILE__" not in content
187187

188+
def test_plan_defines_quickstart_as_validation_guide(self, tmp_path):
189+
"""The generated plan command should keep quickstart.md out of implementation scope."""
190+
i = get_integration("generic")
191+
m = IntegrationManifest("generic", tmp_path)
192+
i.setup(tmp_path, m, parsed_options={"commands_dir": ".custom/cmds"})
193+
plan_file = tmp_path / ".custom" / "cmds" / "speckit.plan.md"
194+
assert plan_file.exists()
195+
content = plan_file.read_text(encoding="utf-8")
196+
197+
assert "Create quickstart validation guide" in content
198+
assert "runnable validation scenarios" in content
199+
assert "Do not include full implementation code" in content
200+
assert "implementation details belong in `tasks.md` and the implementation phase" in content
201+
188202
def test_implement_loads_constitution_context(self, tmp_path):
189203
"""The generated implement command should load constitution governance context."""
190204
i = get_integration("generic")

0 commit comments

Comments
 (0)