GitHub Issue Template forms

YAML GitHub issue forms

Type object
File match **/.github/ISSUE_TEMPLATE/!(config).yml **/.github/ISSUE_TEMPLATE/!(config).yaml
Schema URL https://catalog.lintel.tools/schemas/github/github-issue-template-forms/latest.json
Source https://www.schemastore.org/github-issue-forms.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

description string required

An issue template description https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax

Examples: "Sample description"
minLength=1
body form_item[] required

An issue template body https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax

minItems=1
title string

An issue template title https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax

Examples: "Sample title", "Bug: ", "Feature: "
minLength=1
projects string[]

Projects that any issues created with this template will automatically be added to.

type string

An issue type, currently in beta https://github.com/orgs/community/discussions/139933

Examples: "Bug", "Enhancement"
minLength=1

Definitions

id string
Examples:
  • "SampleId"
validations object
required boolean

Specify whether require a form item

Default: false
upload_validations object

Upload validations https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#validations-for-upload

required boolean

Specify whether require a form item

Default: false
accept string

A comma-separated list of file extensions that are accepted. If omitted, all supported file types are accepted.

Examples: ".png,.jpg,.gif,.log,.txt,.zip"
assignee string
Examples:
  • "SampleAssignee"
label string
Examples:
  • "Sample label"
description string
Examples:
  • "Sample description"
placeholder string
Examples:
  • "Sample placeholder"
value string
Examples:
  • "Sample value"