GitHub Issue Template Generator

Design a GitHub issue form and get the YAML for .github/ISSUE_TEMPLATE.

Save as .github/ISSUE_TEMPLATE/bug_report.yml.

name: "Bug report"
description: "Tell us what is not working"
title: "[Bug]:"
labels: ["bug", "triage"]
body:
  - type: textarea
    id: what-happened
    attributes:
      label: "What happened?"
      description: "Include what you expected instead."
    validations:
      required: true
  - type: dropdown
    id: severity
    attributes:
      label: "Severity"
      options:
        - "Low"
        - "Medium"
        - "High"

How to use

1

Name the template and add labels, a title prefix and assignees if you want them.

2

Add the fields reporters should fill in and mark the required ones.

3

Copy the YAML into .github/ISSUE_TEMPLATE/ and commit it.

Example

A required description field

Each field gets an id made from its label.

Input
Multi line field "What happened?", required
Output
- type: textarea
  id: what-happened
  attributes:
    label: "What happened?"
  validations:
    required: true

Frequently Asked Questions

In .github/ISSUE_TEMPLATE/ in your repository, with a .yml extension. Each file becomes one choice on the new issue page.

Explore

Connected career roadmaps, algorithmic problems, and real-world curricula related to GitHub Issue Template Generator.