Skip to content

fix: Use blank lines in template headers to prevent markdownlint stripping line breaks #1344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
echarrod wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −3
Open

fix: Use blank lines in template headers to prevent markdownlint stripping line breaks #1344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions templates/plan-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Implementation Plan: [FEATURE]

**Branch**: `[###-feature-name]` | **Date**: [DATE] | **Spec**: [link]

**Input**: Feature specification from `/specs/[###-feature-name]/spec.md`

**Note**: This template is filled in by the `/speckit.plan` command. See `.specify/templates/commands/plan.md` for the execution workflow.
Expand Down
9 changes: 6 additions & 3 deletions templates/spec-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# Feature Specification: [FEATURE NAME]

**Feature Branch**: `[###-feature-name]`
**Created**: [DATE]
**Status**: Draft
**Feature Branch**: `[###-feature-name]`

**Created**: [DATE]

**Status**: Draft

Copy link

@wmalgadey wmalgadey Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe a better approach would be to add double spaces at the end of the line? this would not break linting as well and would be a nicer visual IMO

**Feature Branch**: `[###-feature-name]`  
**Created**: [DATE]  
**Status**: Draft

Copy link
Author

@echarrod echarrod Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree it looks slightly nicer, but I outlined in the source issue (#1343) that markdownlint (used by many tools) removes the double spaces from these lines automatically

**Input**: User description: "$ARGUMENTS"

## User Scenarios & Testing *(mandatory)*
Expand Down
1 change: 1 addition & 0 deletions templates/tasks-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ description: "Task list template for feature implementation"
# Tasks: [FEATURE NAME]

**Input**: Design documents from `/specs/[###-feature-name]/`

**Prerequisites**: plan.md (required), spec.md (required for user stories), research.md, data-model.md, contracts/

**Tests**: The examples below include test tasks. Tests are OPTIONAL - only include them if explicitly requested in the feature specification.
Expand Down