mirror of
https://github.com/Tyrrrz/DiscordChatExporter.git
synced 2026-02-14 15:53:30 -07:00
Update issue forms
This commit is contained in:
parent
cd5afd07ac
commit
88dee76690
80
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
80
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
|
|
@ -1,4 +1,4 @@
|
||||||
name: 🐞 Bug report
|
name: 🐛 Bug report
|
||||||
description: Report broken functionality.
|
description: Report broken functionality.
|
||||||
labels: [bug]
|
labels: [bug]
|
||||||
|
|
||||||
|
|
@ -6,26 +6,27 @@ body:
|
||||||
- type: markdown
|
- type: markdown
|
||||||
attributes:
|
attributes:
|
||||||
value: |
|
value: |
|
||||||
🧐 **Guidelines:**
|
### 📖 Important
|
||||||
|
|
||||||
- Search through [existing issues](https://github.com/Tyrrrz/DiscordChatExporter/issues?q=is%3Aissue) first to ensure that this bug has not been reported before.
|
- Avoid generic or vague titles such as "Something's not working" or "A couple of problems" — be as descriptive as possible.
|
||||||
- Write a descriptive title for your issue. Avoid generic or vague titles such as "Something's not working" or "A couple of problems".
|
|
||||||
- Keep your issue focused on one single problem. If you have multiple bug reports, please create separate issues for each of them.
|
- Keep your issue focused on one single problem. If you have multiple bug reports, please create separate issues for each of them.
|
||||||
- Provide as much context as possible in the details section. Include screenshots, screen recordings, links, references, or anything else you may consider relevant.
|
- Issues should represent **complete and actionable** work items. If you are unsure about something or have a question, please start a [discussion](https://github.com/Tyrrrz/DiscordChatExporter/discussions/new) instead.
|
||||||
- If you want to ask a question instead of reporting a bug, please use [discussions](https://github.com/Tyrrrz/DiscordChatExporter/discussions/new) instead.
|
- Remember that DiscordChatExporter is an open-source project funded by the community. If you find it useful, **please consider [donating](https://tyrrrz.me/donate) to support its development**.
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
- type: input
|
- type: input
|
||||||
attributes:
|
attributes:
|
||||||
label: Version
|
label: Version
|
||||||
description: Which version of DiscordChatExporter does this bug affect?
|
description: Which version of the application does this bug affect?
|
||||||
placeholder: ver X.Y.Z
|
placeholder: v1.0.0
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
attributes:
|
attributes:
|
||||||
label: Flavor
|
label: Flavor
|
||||||
description: Does this bug affect the GUI version, the CLI version, or both?
|
description: Which flavor(s) of the application does this bug affect?
|
||||||
multiple: true
|
multiple: true
|
||||||
options:
|
options:
|
||||||
- GUI (Graphical User Interface)
|
- GUI (Graphical User Interface)
|
||||||
|
|
@ -33,10 +34,18 @@ body:
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Platform
|
||||||
|
description: What platform do you experience this bug on?
|
||||||
|
placeholder: Docker / Windows 11
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
- type: dropdown
|
- type: dropdown
|
||||||
attributes:
|
attributes:
|
||||||
label: Export format
|
label: Export format
|
||||||
description: Does this bug affect specific export format(s)? If not applicable, leave this field blank.
|
description: Which export format(s) do you experience this bug with, if applicable?
|
||||||
multiple: true
|
multiple: true
|
||||||
options:
|
options:
|
||||||
- HTML
|
- HTML
|
||||||
|
|
@ -44,21 +53,54 @@ body:
|
||||||
- JSON
|
- JSON
|
||||||
- CSV
|
- CSV
|
||||||
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Details
|
|
||||||
description: Clear and thorough explanation of the bug.
|
|
||||||
placeholder: I was doing X expecting Y to happen, but Z happened instead.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
attributes:
|
attributes:
|
||||||
label: Steps to reproduce
|
label: Steps to reproduce
|
||||||
description: Minimum steps required to reproduce the bug.
|
description: >
|
||||||
|
Minimum steps required to reproduce the bug, including prerequisites, export settings, or other relevant items.
|
||||||
|
The information provided in this field must be readily actionable, meaning that anyone should be able to reproduce the bug by following these steps.
|
||||||
|
If the bug depends on external factors (such as a specific server, channel, or message), please provide the server invite and the corresponding link.
|
||||||
placeholder: |
|
placeholder: |
|
||||||
|
Server invite: https://discord.gg/...
|
||||||
|
Channel or message link: https://discord.com/channels/.../...
|
||||||
|
|
||||||
|
Export settings:
|
||||||
|
- ...
|
||||||
|
|
||||||
|
Steps:
|
||||||
- Step 1
|
- Step 1
|
||||||
- Step 2
|
- Step 2
|
||||||
- Step 3
|
- Step 3
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Details
|
||||||
|
description: Clear and thorough explanation of the bug, including any additional information you may find relevant.
|
||||||
|
placeholder: |
|
||||||
|
- Expected behavior: ...
|
||||||
|
- Actual behavior: ...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Checklist
|
||||||
|
description: Quick list of checks to ensure that everything is in order.
|
||||||
|
options:
|
||||||
|
- label: I have looked through existing open and closed issues to make sure that this bug has not been reported before
|
||||||
|
required: true
|
||||||
|
- label: I have provided a descriptive title for this issue
|
||||||
|
required: true
|
||||||
|
- label: I have made sure that that this bug is reproducible on the latest version of the application
|
||||||
|
required: true
|
||||||
|
- label: I have provided all the information needed to reproduce this bug as efficiently as possible
|
||||||
|
required: true
|
||||||
|
- label: I have sponsored this project
|
||||||
|
required: false
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
If you are struggling to provide actionable reproduction steps, or if something else is preventing you from creating a complete bug report, please start a [discussion](https://github.com/Tyrrrz/DiscordChatExporter/discussions/new) instead.
|
||||||
|
|
|
||||||
8
.github/ISSUE_TEMPLATE/config.yml
vendored
8
.github/ISSUE_TEMPLATE/config.yml
vendored
|
|
@ -3,12 +3,12 @@ contact_links:
|
||||||
- name: ⚠ Feature request
|
- name: ⚠ Feature request
|
||||||
url: https://github.com/Tyrrrz/.github/blob/master/docs/project-status.md
|
url: https://github.com/Tyrrrz/.github/blob/master/docs/project-status.md
|
||||||
about: Sorry, but this project is in maintenance mode and no longer accepts new feature requests.
|
about: Sorry, but this project is in maintenance mode and no longer accepts new feature requests.
|
||||||
- name: 💬 Discord server
|
|
||||||
url: https://discord.gg/2SUWKFnHSm
|
|
||||||
about: Chat with the project community.
|
|
||||||
- name: 📖 Documentation
|
- name: 📖 Documentation
|
||||||
url: https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs
|
url: https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs
|
||||||
about: Find usage guides and frequently asked questions.
|
about: Find usage guides and frequently asked questions.
|
||||||
- name: 🗨 Discussions
|
- name: 🗨 Discussions
|
||||||
url: https://github.com/Tyrrrz/DiscordChatExporter/discussions/new
|
url: https://github.com/Tyrrrz/DiscordChatExporter/discussions/new
|
||||||
about: Ask and answer questions.
|
about: Ask and answer questions.
|
||||||
|
- name: 💬 Discord server
|
||||||
|
url: https://discord.gg/2SUWKFnHSm
|
||||||
|
about: Chat with the project community.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue