📝 Feat: Add issue templates

This commit is contained in:
James Musselman 2025-03-14 19:53:47 -05:00
parent 351a8f8547
commit a876c3e216
Signed by: Musselman
GPG key ID: 1DAEFF35ECB5D6DB
3 changed files with 91 additions and 0 deletions

View file

@ -0,0 +1,60 @@
name: 🐛 Bug Report
description: Found something you weren't expecting? Report it here!
title: "[BUG] "
labels: bug/new-report
body:
- type: markdown
attributes:
value: |
**NOTE: If your issue is a security concern, please email the email in the README instead of opening a public issue.**
- type: markdown
attributes:
value: |
- Please speak English, as this is the language all maintainers can speak and write.
- Be as clear and concise as possible. A very verbose report is harder to interpret in a concrete way.
- Be civil and use common sense.
- Take a moment to *check that your issue hasn't been reported before*.
- type: dropdown
id: can-reproduce
attributes:
label: Can you reproduce the bug on the demo instance?
description: |
It is running the latest development branch and will confirm the problem is not already fixed.
If you can reproduce it, provide a URL in the description.
options:
- "Yes"
- "No"
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: |
Please provide a description of your issue here, with a URL if you were able to reproduce the issue (see above).
validations:
required: true
- type: input
id: software-ver
attributes:
label: Software Version
description: Software version (or commit reference) of your instance
- type: textarea
id: run-info
attributes:
label: How are you running the software?
description: |
Please include information on whether you built the software yourself, used one of our downloads, or are using some other package.
Please also tell us how you are running the software, e.g. if it is being run from a container, a command-line, systemd etc.
If you are using a package or systemd tell us what distribution you are using.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Logs
description: |
It's really important to provide pertinent logs. You must give us `DEBUG` level logs.
Please copy and paste your logs here, with any sensitive information (e.g. API keys) removed/hidden.
You can wrap your logs in `<details>...</details>` tags so it doesn't take up too much space in the issue.

View file

View file

@ -0,0 +1,31 @@
name: 💡 Feature Request
description: Got an idea for a feature that the software doesn't have yet? Suggest it here!
title: "[FEAT] "
labels: ["enhancement/feature"]
body:
- type: markdown
attributes:
value: |
- Please speak English, as this is the language all maintainers can speak and write.
- Be as clear and concise as possible. A very verbose request is harder to interpret in a concrete way.
- Be civil and use common sense.
- Take a moment to *check that your issue hasn't been reported before*.
- type: textarea
id: needs-benefits
attributes:
label: Needs and benefits
description: As concisely as possible, describe the benefits your feature request will provide or the problems it will try to solve.
validations:
required: true
- type: textarea
id: description
attributes:
label: Feature Description
description: As concisely as possible, describe the feature you would like to see added or the changes you would like to see made to the software.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If you can, provide screenshots of an implementation on another site.