fix: align checklist guidance with docs#2816
Closed
meow2149 wants to merge 1 commit into
Closed
Conversation
Signed-off-by: meow2149 <maojiuyuqi794@gmail.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Aligns the specify init “Enhancement” guidance with the Quick Start docs by clarifying that /speckit-checklist is intended to be run before /speckit-plan (as a requirements-quality gate), and adds a focused regression assertion for Copilot skills mode output.
Changes:
- Update
specify initchecklist description from “after plan” to “before plan”. - Add a test assertion ensuring Copilot skills-mode next-steps output contains “before /speckit-plan” and does not contain “after /speckit-plan”.
Show a summary per file
| File | Description |
|---|---|
src/specify_cli/commands/init.py |
Updates the printed “checklist” next-steps guidance to indicate it should be run before planning. |
tests/integrations/test_integration_copilot.py |
Adds a regression assertion for the corrected checklist guidance in Copilot skills mode output. |
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
Collaborator
|
The docs were actually wrong here. The checklists are meant as "unit tests but then in English" which means they are meant for after plan. So what we need to update is the docs |
5 tasks
jawwad-ali
added a commit
to jawwad-ali/spec-kit
that referenced
this pull request
Jun 23, 2026
The quickstart workflow showed /speckit.checklist before /speckit.plan, contradicting the CLI next-steps text (commands/init.py), which lists the checklist as running after the plan. Per the maintainer on github#2816 — "the docs were actually wrong here ... checklists are meant for after plan" — align the docs to the CLI: move /speckit.checklist after /speckit.plan in the workflow diagram, the prose, and both walkthrough step sequences. Docs-only; no behavior change. Closes github#2606 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
mnriem
pushed a commit
that referenced
this pull request
Jun 24, 2026
* docs: run /speckit.checklist after /speckit.plan in quickstart The quickstart workflow showed /speckit.checklist before /speckit.plan, contradicting the CLI next-steps text (commands/init.py), which lists the checklist as running after the plan. Per the maintainer on #2816 — "the docs were actually wrong here ... checklists are meant for after plan" — align the docs to the CLI: move /speckit.checklist after /speckit.plan in the workflow diagram, the prose, and both walkthrough step sequences. Docs-only; no behavior change. Closes #2606 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs: reword checklist as generating quality checklists, not validating directly Address review: /speckit.checklist generates quality checklists (which then validate the requirements) rather than validating directly, matching the CLI/README phrasing. Preserves the after-plan ordering. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs: align checklist wording with CLI next-steps phrasing Address review: state the checklist's purpose (validate requirements completeness, clarity, and consistency) and anchor it to /speckit.plan as the CLI does, use the plural 'quality checklists', and reword the Taskify step so the spec is validated using the generated checklists. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
Aligns the
specify initnext-steps guidance with the Quick Start docs by describing/speckit.checklistas a requirements-quality gate to run before/speckit.plan, not after it.Fixes #2606
Testing
uv run specify --helpuv sync && uv run pytestAdditional validation:
uv run pytest tests/integrations/test_integration_copilot.py::TestCopilotSkillsMode::test_init_skills_next_steps_show_skill_syntax -qgit diff --checkuv run specify init <tmp>/checklist-order --integration copilot --integration-options "--skills" --no-gitand verified the output saysbefore /speckit-planand notafter /speckit-planAI Disclosure
This PR was prepared with Cursor AI assistance. I reviewed the issue, compared the CLI guidance with the Quick Start docs, made the minimal text change, and added a focused regression assertion.
Made with Cursor