fix: make template metadata line breaks markdownlint-safe#2505
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the core Markdown templates to avoid relying on trailing-space hard breaks for rendering template “metadata” fields, making them resilient to markdownlint/auto-formatters that strip trailing whitespace (fixes #1343).
Changes:
- Replaced trailing-double-space hard breaks with explicit blank lines between template header/metadata fields.
- Removed trailing whitespace in the affected templates (including within comment blocks).
- Adjusted formatting so key template fields render as separate paragraphs across common Markdown parsers/editors.
Show a summary per file
| File | Description |
|---|---|
| templates/spec-template.md | Splits header metadata fields into separate paragraphs and removes trailing-space hard breaks. |
| templates/plan-template.md | Adds blank lines between technical-context metadata fields to prevent paragraph collapsing when trailing spaces are stripped. |
| templates/tasks-template.md | Adds spacing after the Input field and cleans up whitespace in the instructional comment block. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 3/3 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.
Summary
Fixes #1343
Validation
git diff --check -- templates/spec-template.md templates/plan-template.md templates/tasks-template.mdrg -n " $" templates/spec-template.md templates/plan-template.md templates/tasks-template.mdcache