Skip to content

fix: make template metadata line breaks markdownlint-safe#2505

Merged
mnriem merged 1 commit into
github:mainfrom
WOLIKIMCHENG:fix-template-line-breaks-1343
May 12, 2026
Merged

fix: make template metadata line breaks markdownlint-safe#2505
mnriem merged 1 commit into
github:mainfrom
WOLIKIMCHENG:fix-template-line-breaks-1343

Conversation

@WOLIKIMCHENG
Copy link
Copy Markdown
Contributor

@WOLIKIMCHENG WOLIKIMCHENG commented May 9, 2026

Summary

  • Replace trailing-space Markdown hard breaks in core templates with explicit blank lines
  • Separate template metadata fields so markdownlint/editor auto-fix does not collapse them into one rendered paragraph
  • Clean trailing whitespace in the affected templates

Fixes #1343

Validation

  • git diff --check -- templates/spec-template.md templates/plan-template.md templates/tasks-template.md
  • rg -n " $" templates/spec-template.md templates/plan-template.md templates/tasks-template.md
  • Temporary preview/paragraph assertion for key template fields
  • Markdown preview screenshot generated locally
    cache

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

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

@mnriem mnriem merged commit 756d632 into github:main May 12, 2026
15 checks passed
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.

Template header fields collapse to single line when markdownlint strips trailing spaces

3 participants