GitHub issue template generator
Build an issue form, a pull request template and the template chooser config, checked against GitHub's own schema.
Comma-separated.
GitHub usernames, comma-separated.
Fields
- Input1
- Textarea2
Add
name: Question
description: Ask a question about using this project
title: "[Question]: "
labels:
- question
body:
- type: input
id: topic
attributes:
label: Topic
placeholder: Installation, configuration, ...
validations:
required: true
- type: textarea
id: question
attributes:
label: Your question
description: Include what you have already tried.
validations:
required: true
Question
Ask a question about using this project
Add a title
Topic
Your question
Include what you have already tried.
Topic
<!-- Installation, configuration, ... -->Your question
No response
Checking against the GitHub schema
.github/pull_request_template.md
Preview
Summary
What does this change, and why?
Changes
Testing
How did you check it?
Checklist
- Tests added or updated
- Docs updated
Contact links
- Link 1
YAML.github/ISSUE_TEMPLATE/config.yml
blank_issues_enabled: false
contact_links:
- name: Documentation
url: https://example.com/docs
about: Read the docs before opening an issue.
Checking against the GitHub schema
How to make a GitHub issue template
- 1Start from a bug report, feature request or question, or paste a form you already have.
- 2Add fields, reorder them and watch the form as GitHub renders it. Fix anything the check flags.
- 3Copy or download the file into .github/ISSUE_TEMPLATE/ and push it to your default branch.
FAQ
Where do I put the issue form file?
Save it in .github/ISSUE_TEMPLATE/ in your repository, with a .yml extension. GitHub lists it in the template chooser once it is on the default branch.
What is the difference between an issue form and a Markdown template?
An issue form is a YAML file that shows real inputs, dropdowns and checkboxes, and can require answers. A Markdown template only prefills the text box.
Where does the pull request template go?
Save it as .github/pull_request_template.md. GitHub fills every new pull request description with it.
What does config.yml do?
It sets up the template chooser: whether people can open a blank issue, and which contact links appear beside the templates. It lives at .github/ISSUE_TEMPLATE/config.yml.
Is my form sent anywhere?
No. The form is built and checked in your browser, against GitHub's published schema.
Gitsu reads your repository's issue forms and fills them in when you create an issue from your board.
Try Gitsu free