Skip to content

Issue template

Every Linear issue created by /linear:plan-work follows the same seven-section structure. Each heading answers a natural question so the reader can scan quickly and know exactly what the issue is about.

Sections

#SectionQuestion it answers
1Why this mattersShould I care?
2Where things standWhat's the current state?
3What we'll doWhat's the plan?
4What we won't doWhere's the boundary?
5Expected outcomeHow do we know it's done?
6How to test itHow do we verify?
7Assumptions to confirmWhat's still uncertain?

Sections 4, 6, and 7 are optional — omit them when they don't add value.

Example

Verify new issue template format renders correctly

Why this matters

Every issue we create uses this template. If the format is broken, every card in the backlog is harder to read.

Where things stand

The issue template has new conversational headings but no one has checked whether they render correctly in Linear's markdown.

What we'll do

  • Create a single placeholder issue using the new template format
  • Visual check that all sections render as expected

What we won't do

No changes to the template based on this card — just validation.

Expected outcome

  • Issue appears in Linear with all sections visible and correctly formatted
  • "Why this matters" section appears first, before "Where things stand"
  • All headings render as distinct sections with no overlap

How to test it

Visual inspection in Linear — open the issue and confirm each heading renders as a separate section with correct hierarchy.

Assumptions to confirm

  • Linear renders h3 markdown headings consistently across views (board, detail, sidebar)

Design principles

The headings are deliberately conversational — they work equally well for bugs, features, and improvements. "Where things stand" is neutral: it can describe a broken API, a missing feature, or an opportunity for something new.

The template avoids overlap between sections. Earlier versions had separate Goal, Acceptance criteria, and Success metric sections that all answered "how do we know it's done?" — these were merged into a single Expected outcome.