fix(templates): remove self-referencing path in plan-template.md note#3417
Open
marcelsafin wants to merge 1 commit into
Open
fix(templates): remove self-referencing path in plan-template.md note#3417marcelsafin wants to merge 1 commit into
marcelsafin wants to merge 1 commit into
Conversation
The note told readers to "See .specify/templates/plan-template.md for the execution workflow" — that path is the file itself. The execution workflow lives in the plan command's definition, which the note already names via the __SPECKIT_COMMAND_PLAN__ placeholder. Point there instead of at a self-reference. Fixes github#1148 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a confusing self-referential note in templates/plan-template.md by removing a pointer to the template’s own path and instead directing readers to the __SPECKIT_COMMAND_PLAN__ command definition for the execution workflow, aligning with the agent-agnostic templating approach used throughout Spec Kit.
Changes:
- Updated the “Note” in the plan template to remove the hardcoded/self-referencing
.specify/templates/plan-template.mdpath. - Reworded the note to reference the
__SPECKIT_COMMAND_PLAN__command definition as the source of execution workflow guidance.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Fixes #1148
Root cause
The note at the top of
templates/plan-template.mdsays:That path is the file itself — a self-reference. The execution workflow actually lives in the plan command's definition, which the same sentence already names via the
__SPECKIT_COMMAND_PLAN__placeholder (rendered per-agent, e.g./speckit.plan).An earlier attempt (#1342) went stale and was auto-closed; this picks the issue back up with the same intent — make the note point at the right thing without hardcoding any agent-specific path.
Change
One line: the note now reads "This template is filled in by the
__SPECKIT_COMMAND_PLAN__command; its definition describes the execution workflow."Testing
No tests pin this template's prose; the placeholder continues to render through the existing
resolve_command_refspipeline (shared_infra.py).