Use forms for issue templates (#933)

This uses the GitHub Form Syntax to make richer issue templates. I took
a lot of inspiration from the Dioxus project for the wording of these
templates.
This commit is contained in:
Evan Simkowitz 2024-10-02 16:09:16 -07:00 committed by GitHub
parent 57c2f02c9d
commit 47c50dc29b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 89 additions and 45 deletions

View File

@ -1,31 +0,0 @@
---
name: Bug Report
about: Create a bug report to help us improve
title: ''
labels: ''
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Desktop (please complete the following information):**
- OS: [e.g. MacOS/Linux, x64 or arm64]
- Version [e.g. v0.5.0]
**Additional context**
Add any other context about the problem here.

63
.github/ISSUE_TEMPLATE/bug-report.yml vendored Normal file
View File

@ -0,0 +1,63 @@
name: Bug Report
description: Create a bug report to help us improve.
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
1. With this config...
1. Run '...'
1. See error...
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: Ubuntu 20.04
- **Architecture**: arm64
- **Version**: v0.8.8
value: |
- OS:
- Architecture:
- Version:
render: markdown
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
- type: checkboxes
attributes:
label: Questionnaire
description: "If you feel up to the challenge, please check one of the boxes below:"
options:
- label: I'm interested in fixing this myself but don't know where to start
required: false
- label: I would like to fix and I have a solution
required: false
- label: I don't have time to fix this right now, but maybe later
required: false

View File

@ -1,14 +0,0 @@
---
name: Feature Request
about: Suggest a new idea for this project
title: ''
labels: ''
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.

View File

@ -0,0 +1,26 @@
name: Feature Request
description: Suggest a new idea for this project.
title: "[Feature]: "
labels: ["enhancement", "triage"]
body:
- type: textarea
attributes:
label: Feature description
description: Describe the issue in detail and why we should add it. To help us out, please poke through our issue tracker and make sure it's not a duplicate issue. Ex. As a user, I can do [...]
validations:
required: true
- type: textarea
attributes:
label: Implementation Suggestion
description: If you have any suggestions on how to design this feature, list them here.
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about how to deliver your feature!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false