⌘ K
bug · feature · custom · YAML front matter

Generate a GitHub issue template

Drop a .md into .github/ISSUE_TEMPLATE/ to standardise bug reports and feature requests across your repo.

Issue Template Generator
Template
393 B
34 lines
Kind
bug
.github/ISSUE_TEMPLATE
Labels
2
bug, triage
Assignees
0
none
input · fields
output · bug.md
---
name: Bug report
about: Create a report to help us improve
title: '[Bug] '
labels: bug, triage
---

## Describe the bug

A clear and concise description.

## To Reproduce

1. Go to '...'
2. Click on '...'
3. See error

## Expected behavior

What you expected to happen.

## Screenshots

If applicable.

## Environment

- OS:
- Browser:
- Version:

## Additional context

Any other context.
Quick Start

How to generate an issue template

Pick a kind, fill in the front-matter fields, drop the file into .github/ISSUE_TEMPLATE/.

  1. 01

    Pick a kind

    Bug, feature, or blank — body changes accordingly.

    Parsing runs through marked with GFM extensions enabled — tables, task lists, strikethrough, and fenced code blocks all match GitHub’s rendering.

    kindGFMmarkedCommonMarklive
    preset · markdownbug · GFM
    bug | feature | blank
    loaded · GFMGFM · ready
  2. 02

    Front matter

    Name and About show up in GitHub's chooser when someone opens a new issue.

    Soft-break behaviour is configurable: by default a single newline becomes a space (CommonMark), toggle on for chat-style <br> insertion.

    metasoft-breaksoptionsconfiglive
    front · optionsmatter · live
    name: Bug report
about: ...
    options applied · livelive
  3. 03

    Labels and assignees

    Auto-apply when the issue is opened.

    The preview is scoped under a .mde class so its CSS doesn’t bleed into the rest of the page. Output HTML is whitespace-controlled for clean diffs.

    routingpreviewscoped CSSrenderstable
    labels · renderedset · ready
    labels: bug, triage
    rendered · liverendered
  4. 04

    Commit the file

    Path is .github/ISSUE_TEMPLATE/<kind>.md.

    Export covers both raw Markdown and rendered HTML; downloads stream as text/markdown or text/html via Blob + object URL.

    exportclipboard.md.htmlblob
    ✓ · exportedready · done
    ✓ Copied template
    shipped · ready to shipsuccess
Pro tips

Author Markdown that renders everywhere

GFM is the safe default

GitHub-Flavored Markdown is the de-facto baseline (tables, task lists, strikethrough). CommonMark is stricter but ubiquitous as a fallback.

Soft-break behaviour varies

A single newline is a space in CommonMark, a <br> in GFM. Toggle soft breaks when source matters.

Escape inside code fences

Backticks inside fenced blocks need a longer fence — three becomes four. Use ~~~ if your content has many backticks.

Anchors are slugified

GitHub lowercases, strips punctuation, and joins with hyphens. Duplicate headings get -1, -2 suffixes.

Tables need a header row

The dash row sets alignment (:---, :-:, ---:). Use Table Aligner for diff-friendly columns.

Front matter is YAML

Triple-dash blocks at the top of files are parsed by static-site generators. Use the Front-Matter Validator to catch syntax errors.

Related toolsPR TemplateDiscussionsCONTRIBUTINGCode of ConductREADMEFront Matter
Use Cases

When to add issue templates

Public repos, internal queues, triage flows.

Public OSS

Force good bug reports — environment, repro steps, expected behaviour. Render path uses marked with GFM extensions enabled (tables, task lists, strikethrough, autolinks), so what you preview matches what GitHub publishes bit-for-bit. Soft-break behaviour is configurable for chat-style vs prose Markdown.

GFM-compliant

Triage routing

Auto-label and auto-assign so issues land in the right queue. Pairs cleanly with the Markdown Cheatsheet for syntax you can't quite remember — callout blocks, footnotes, definition lists. Output stays diff-friendly so style-only changes don't drown out real edits in PRs.

GitHub-perfect

Feature intake

Standard shape for requests makes prioritisation easier. Cross-platform safe: anchors, code fences, and tables behave identically on GitHub, GitLab, Bitbucket, and Gitea. Heading-anchor slugs follow GitHub's lowercase-and-hyphenate rules so deep links survive a docs migration.

diff-friendly

Internal tooling

Use templates for incident reports and on-call queues. No server roundtrip — perfect for proprietary content you can't paste into a public tool. The full marked + GFM bundle ships with the page, so it works offline once loaded.

render-stable

Audit pass

Migrate ad-hoc issues to a standard format. Front matter (YAML / TOML / JSON) passes through unchanged so static-site pipelines (Jekyll, Hugo, Astro, Eleventy) read it correctly. Pair with the Front-Matter Validator to catch syntax errors before deploy.

cross-platform

Education

Teach contributors what a good report looks like. Output is reproducible: identical input always produces identical Markdown, so doc-generation scripts can rely on it for snapshot tests and embedded into release workflows.

SEO-friendly
FAQ

Frequently asked questions

Put it in .github/ISSUE_TEMPLATE/<kind>.md at the root of your repo.
Markdown is simpler; YAML forms give you typed inputs. We generate Markdown — convert to forms once your needs grow.
Yes — generate once per kind. GitHub shows a chooser when opening an issue.
GitHub reads the labels front-matter field and applies them when the issue is created.
No — generated locally and runs locally in your browser.
Suggest a tool

Something missing?

Tell us what you need. We ship the top requests every two weeks.

Sent straight to the maintainers · no account needed
47 in queue·8 shipped this month
Request queued. Thanks!