feat: improve bug report template

This commit is contained in:
guse 2024-06-25 23:25:13 +02:00 committed by Fini
parent 9f90a4ecb7
commit fce46e4ba5
2 changed files with 54 additions and 51 deletions

View file

@ -1,51 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
#### 🗹 Requirements
<!-- ⚠️ !!!
If you are unsure what you are reporting is an issue or
it's a general question please go to the gitter chat instead: https://gitter.im/ryanoasis/nerd-fonts
⚠️ !!! -->
<!-- ⚠️ !!! Issues not filled out with the template will be closed straight away and will only be responded to once filled properly ⚠️ !!! -->
<!-- By posting an issue you acknowledge the following: -->
- [ ] I have searched the [issues](https://github.com/ryanoasis/nerd-fonts/issues) for my issue and found nothing related and/or helpful
- [ ] I have searched the [FAQ](https://github.com/ryanoasis/nerd-fonts/wiki/FAQ-and-Troubleshooting) for help
- [ ] I have searched the [Wiki](https://github.com/ryanoasis/nerd-fonts/wiki) for help
#### 🎯 Subject of the issue
Experienced behavior:
<!-- Describe issue here -->
Expected behavior:
<!-- Please do not forget to explain what you would have expected to see -->
Example symbols:
<!-- The codepoint of one or more affected symbols, or paste the text containing the issue here (no screenshot) -->
#### 🔧 Your Setup
- _Which font are you using (e.g. `Anonymice Powerline Nerd Font Complete.ttf`)?_
- _Please give the full filename_
- _Where did you get the file from (download link, self patched, source downloaded from link...)_
- <!-- Type your answer here -->
- _Which terminal emulator are you using (e.g. `iterm2`, `urxvt`, `gnome`, `konsole`)?_
- <!-- Type your answer here -->
- _Are you using OS X, Linux or Windows? And which specific version or distribution?_
- <!-- Type your answer here -->
#### ★ Screenshots (Optional)
<!-- Provide screenshots where appropriate, they help tremendously -->
<!-- Try to include the title of terminal windows and possibly settings dialogues -->

54
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View file

@ -0,0 +1,54 @@
name: Bug Report
description: Help us improve by reporting an issue.
body:
- type: checkboxes
attributes:
label: Requirements
options:
- label: "I have searched the [issues](https://github.com/ryanoasis/nerd-fonts/issues) for my issue and found nothing related or helpful"
required: true
- label: "I have searched the [FAQ](https://github.com/ryanoasis/nerd-fonts/wiki/FAQ-and-Troubleshooting) for help"
required: true
- label: "I have checked the [Wiki](https://github.com/ryanoasis/nerd-fonts/wiki) for help"
required: true
- type: textarea
attributes:
label: Experienced Behavior
description: Describe the issue you encountered.
- type: textarea
attributes:
label: Expected Behavior
description: Explain what you expected to happen.
- type: textarea
attributes:
label: Example Symbols or Text
description: Provide the codepoint of affected symbols or paste the text causing the issue (no screenshots).
- type: input
attributes:
label: Font Used
placeholder: Specify the exact name of the font file.
- type: input
attributes:
label: Source of Font File
placeholder: Link if downloaded, self-patched, or source.
- type: input
attributes:
label: Terminal Emulator
placeholder: Specify your terminal emulator (e.g., iTerm2, urxvt, gnome-terminal).
- type: input
attributes:
label: Operating System and Version
placeholder: Specify OS (e.g., macOS 12.3, Ubuntu 22.04, Windows 11).
- type: textarea
attributes:
label: Additional Context
description: Include any other relevant details or screenshots here.