GitHub Issue Template Generator

Create a bug report, feature request or question template — as a YAML issue form or Markdown — for your repository.

Template

Format

Default label

.github/ISSUE_TEMPLATE/bug_report.yml

name: Bug report
description: Report something that isn't working
labels: ["bug"]
body:
  - type: textarea
    id: what
    attributes:
      label: What happened?
      description: A clear description of the bug.
    validations:
      required: true
  - type: textarea
    id: steps
    attributes:
      label: Steps to reproduce
      description: How can we see the problem?
    validations:
      required: true
  - type: textarea
    id: expected
    attributes:
      label: What did you expect to happen?
      description: The behaviour you wanted.
    validations:
      required: false
  - type: textarea
    id: env
    attributes:
      label: Environment
      description: OS, browser and version.
    validations:
      required: false

Commit the file to your repository at the path shown and GitHub will offer it when someone opens a new issue.

About github issue template generator

Issue templates help people give the details you need when they report a bug or ask for a feature.

Good templates ask for

Steps to reproduce the problem.
What was expected and what happened.
Version, operating system and logs.

Where it goes

Save the file in .github/ISSUE_TEMPLATE/ in your repository.

A worked example

A bug report template asks for a short description, steps to reproduce, expected and actual behaviour, the version and any logs. Save it as .github/ISSUE_TEMPLATE/bug_report.md, and GitHub offers it when someone opens a new issue.

Making templates effective

Keep them short, since long forms put people off.
Use labels so that issues are sorted automatically.
Add a link to the discussion board or docs for questions.

Issue forms

GitHub also supports YAML issue forms with required fields and drop-downs. They give more structured reports than plain Markdown templates, if your project needs them.

How to use github issue template generator

1Enter your valuesFill in the fields — example values are already there to start from.

2Adjust the optionsChange the choices to match your situation. Results update as you type.

3Use the resultRead it, or copy it with the Copy button.

Your privacy on this tool

This tool is built so that what you enter stays with you.

Everything you type or upload is processed in your browser, on your own device.
Nothing you enter is sent to our servers, so we cannot see, keep or share it.
We do not save your input. A few tools remember small settings, such as a chosen time zone, in your own browser only.
No account, email address or sign-up is needed, and nothing is watermarked.
If you accept analytics, we count page views and tool use. We never collect the contents of your files or text.
Ads, where shown, sit below the tool and are not given what you enter.

Read the full privacy policy.

Questions people ask

In .github/ISSUE_TEMPLATE/ in your repository.

Forms give structured fields and are recommended; Markdown templates are simpler.

No. Everything is worked out in your browser and nothing you type is sent to a server.

GitHub Actions Workflow Generator GitHub Actions Cron Generator GitHub Actions YAML Validator Git Command Generator Git Reset Command Helper Git Rebase Helper Git Merge Helper .gitignore Generator

About github issue template generator

Issue templates help people give the details you need when they report a bug or ask for a feature.

Good templates ask for

Steps to reproduce the problem.
What was expected and what happened.
Version, operating system and logs.

Where it goes

Save the file in .github/ISSUE_TEMPLATE/ in your repository.

A worked example

Making templates effective

Keep them short, since long forms put people off.
Use labels so that issues are sorted automatically.
Add a link to the discussion board or docs for questions.

Issue forms

GitHub also supports YAML issue forms with required fields and drop-downs. They give more structured reports than plain Markdown templates, if your project needs them.

GitHub Issue Template Generator

About github issue template generator

Good templates ask for

Where it goes

A worked example

Making templates effective

Issue forms

How to use github issue template generator

Your privacy on this tool

Questions people ask

More tools you may like

GitHub Issue Template Generator

About github issue template generator

Good templates ask for

Where it goes

A worked example

Making templates effective

Issue forms

How to use github issue template generator

Your privacy on this tool

Questions people ask

More tools you may like