Last updated
Issue Template Generator Examples
The Issue Template Generator creates structured GitHub and GitLab issue templates. Below are examples of generated templates for bug reports, feature requests, and security issues.
GitHub Bug Report Template (YAML Form)
# .github/ISSUE_TEMPLATE/bug_report.yml
name: Bug Report
description: Report a bug or unexpected behavior
title: "[Bug]: "
labels: ["bug", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug. Please fill in as much detail as possible.
- type: textarea
id: description
attributes:
label: Bug Description
description: A clear and concise description of what the bug is.
placeholder: "When I click the submit button, the form resets instead of submitting."
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Step-by-step instructions to reproduce the issue.
value: |
1. Go to '...'
2. Click on '...'
3. Scroll down to '...'
4. See error
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What did you expect to happen?
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened?
validations:
required: true
- type: dropdown
id: version
attributes:
label: Version
options:
- "2.x (latest)"
- "1.x (legacy)"
- "main branch"
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating System
multiple: true
options:
- Windows
- macOS
- Linux
- iOS
- Android
- type: textarea
id: logs
attributes:
label: Relevant Logs or Screenshots
description: Paste any error messages, stack traces, or attach screenshots.
- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I searched existing issues and this is not a duplicate
required: true
- label: I am using the latest version
required: false
Feature Request Template
# .github/ISSUE_TEMPLATE/feature_request.yml
name: Feature Request
description: Suggest a new feature or improvement
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: textarea
id: problem
attributes:
label: Problem Statement
description: What problem does this feature solve?
placeholder: "I'm frustrated when I have to..."
validations:
required: true
- type: textarea
id: solution
attributes:
label: Proposed Solution
description: Describe the feature you'd like to see.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives Considered
description: Any alternative solutions or workarounds you've tried?
- type: dropdown
id: priority
attributes:
label: Priority
options:
- Nice to have
- Important
- Critical for my use case
Security Vulnerability Template
# .github/ISSUE_TEMPLATE/security.yml
name: Security Vulnerability
description: Report a security issue (will be kept private)
title: "[Security]: "
labels: ["security"]
assignees: ["security-team"]
body:
- type: markdown
attributes:
value: |
⚠️ **Do not disclose vulnerability details publicly.**
This issue will be kept private until a fix is released.
- type: textarea
id: description
attributes:
label: Vulnerability Description
description: Describe the security issue without including exploit details.
validations:
required: true
- type: dropdown
id: severity
attributes:
label: Severity
options:
- Critical
- High
- Medium
- Low
validations:
required: true
- type: textarea
id: impact
attributes:
label: Potential Impact
description: What could an attacker do with this vulnerability?
GitLab Bug Report Template (Markdown)
# .gitlab/issue_templates/Bug.md
## Summary
**Describe the bug:**
## Steps to Reproduce
1.
2.
3.
## Expected Behavior
## Actual Behavior
## Environment
- **Version:**
- **OS:**
- **Browser (if applicable):**
## Logs / Screenshots
/label ~bug ~needs-triage
Directory Structure
# GitHub
.github/
ISSUE_TEMPLATE/
bug_report.yml
feature_request.yml
security.yml
config.yml ← links to discussions, disables blank issues
# GitLab
.gitlab/
issue_templates/
Bug.md
Feature.md
Security.md
Common Use Cases
- Standardizing bug reports to always include reproduction steps
- Guiding feature requests to include problem context and alternatives
- Routing security issues to the right team automatically
- Reducing back-and-forth by collecting all needed info upfront
- Auto-labeling issues by type for faster triage
- Creating welcoming templates for first-time contributors
Generate complete issue templates for GitHub or GitLab with the correct directory structure and file format, ready to commit to your repository.