Skip to content

fix: align checklist guidance with docs#2816

Open
meow2149 wants to merge 1 commit into
github:mainfrom
meow2149:fix/2606-checklist-guidance-order
Open

fix: align checklist guidance with docs#2816
meow2149 wants to merge 1 commit into
github:mainfrom
meow2149:fix/2606-checklist-guidance-order

Conversation

@meow2149
Copy link
Copy Markdown

@meow2149 meow2149 commented Jun 2, 2026

Description

Aligns the specify init next-steps guidance with the Quick Start docs by describing /speckit.checklist as a requirements-quality gate to run before /speckit.plan, not after it.

Fixes #2606

Testing

  • Tested locally with uv run specify --help
  • Ran existing tests with uv sync && uv run pytest
  • Tested with a sample project (if applicable)

Additional validation:

  • uv run pytest tests/integrations/test_integration_copilot.py::TestCopilotSkillsMode::test_init_skills_next_steps_show_skill_syntax -q
  • git diff --check
  • uv run specify init <tmp>/checklist-order --integration copilot --integration-options "--skills" --no-git and verified the output says before /speckit-plan and not after /speckit-plan

AI Disclosure

  • I did not use AI assistance for this contribution
  • I did use AI assistance (describe below)

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

Signed-off-by: meow2149 <maojiuyuqi794@gmail.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@meow2149 meow2149 marked this pull request as ready for review June 2, 2026 11:57
@meow2149 meow2149 requested a review from mnriem as a code owner June 2, 2026 11:57
@mnriem mnriem requested a review from Copilot June 2, 2026 21:56
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

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 init checklist 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

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.

[Bug]: checklist step is before plan or after??

3 participants