chore: add discussion template

This commit is contained in:
sxyazi
2024-10-25 08:56:08 +08:00
parent 4fcd737db5
commit 591db0ee92
4 changed files with 81 additions and 39 deletions

54
.github/DISCUSSION_TEMPLATE/1-q-a.yml vendored Normal file
View File

@@ -0,0 +1,54 @@
body:
- type: dropdown
id: os
attributes:
label: What system are you running Yazi on?
options:
- Linux X11
- Linux Wayland
- macOS
- Windows
- Windows WSL
- FreeBSD X11
- FreeBSD Wayland
- Android
validations:
required: true
- type: input
id: terminal
attributes:
label: What terminal are you running Yazi in?
placeholder: "ex: kitty v0.32.2"
validations:
required: true
- type: textarea
id: debug
attributes:
label: "`yazi --debug` output"
description: Please run `yazi --debug` and paste the debug information here.
render: Shell
validations:
required: true
- type: textarea
id: description
attributes:
label: Describe the question
description: A clear and concise description of what the question is
placeholder: Tell us what you want to know
validations:
required: true
- type: textarea
id: other
attributes:
label: Anything else?
description: |
Add any other context about the problem here. You can attach screenshots by clicking
this area to highlight it and then drag the files in.
- type: checkboxes
id: validations
attributes:
label: Validations
description: Before submitting the issue, please make sure you have completed the following
options:
- label: I have searched the existing discussions/issues
required: true

View File

@@ -1,4 +1,4 @@
name: Bug Report name: 🐞 Bug Report
description: Create a report to help us improve description: Create a report to help us improve
labels: [bug] labels: [bug]
assignees: [] assignees: []
@@ -15,6 +15,7 @@ body:
- Windows WSL - Windows WSL
- FreeBSD X11 - FreeBSD X11
- FreeBSD Wayland - FreeBSD Wayland
- Android
validations: validations:
required: true required: true
- type: input - type: input
@@ -29,25 +30,7 @@ body:
attributes: attributes:
label: "`yazi --debug` output" label: "`yazi --debug` output"
description: Please run `yazi --debug` and paste the debug information here. description: Please run `yazi --debug` and paste the debug information here.
value: | render: Shell
<details>
```sh
##### ↓↓↓ Paste the output here: ↓↓↓ #####
```
</details>
validations:
required: true
- type: dropdown
id: tried_main
attributes:
label: Did you try the latest nightly build to see if the problem got fixed?
options:
- Yes, and I updated the debug information above (`yazi --debug`) to the nightly that I tried
- No, and I'll explain why below
validations: validations:
required: true required: true
- type: textarea - type: textarea
@@ -59,28 +42,14 @@ body:
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: expected id: reproducer
attributes: attributes:
label: Expected Behavior label: Minimal reproducer
description: A clear and concise description of what you expected to happen description: A [minimal reproducer](https://stackoverflow.com/help/minimal-reproducible-example) is required, otherwise the issue might be closed without further notice.
validations:
required: true
- type: textarea
id: to_repro
attributes:
label: To Reproduce
description: Steps to reproduce the behavior
placeholder: | placeholder: |
Please include as much information as possible that can help to reproduce and understand the issue. Please include as much information as possible that can help to reproduce and understand the issue.
validations: validations:
required: true required: true
- type: textarea
id: config
attributes:
label: Configuration
description: |
Please include the relevant section(s) of your `yazi.toml`, `keymap.toml`, or `theme.toml` configuration file.
You can enter "no config" if the issue happens without you having made a config file.
- type: textarea - type: textarea
id: other id: other
attributes: attributes:

View File

@@ -1,5 +1,8 @@
blank_issues_enabled: false blank_issues_enabled: false
contact_links: contact_links:
- name: Discord server / Telegram group - name: 💬 GitHub Discussions
url: https://github.com/yazi-rs/plugins/discussions/new?category=1-q-a
about: When you have questions that are not bug reports or feature requests
- name: 🌐 Discord Server / Telegram Group
url: https://github.com/sxyazi/yazi#discussion url: https://github.com/sxyazi/yazi#discussion
about: If you'd prefer more realtime conversation with the community about: If you'd prefer more realtime conversation with the community

View File

@@ -1,8 +1,16 @@
name: Feature Request name: 💡 Feature Request
description: Suggest an idea for this project description: Suggest an idea for this project
labels: [feature] labels: [feature]
assignees: [] assignees: []
body: body:
- type: textarea
id: debug
attributes:
label: "`yazi --debug` output"
description: Please run `yazi --debug` and paste the debug information here.
render: Shell
validations:
required: true
- type: textarea - type: textarea
id: problem id: problem
attributes: attributes:
@@ -29,3 +37,11 @@ body:
attributes: attributes:
label: Additional context label: Additional context
description: Add any other context or screenshots about the feature request here. description: Add any other context or screenshots about the feature request here.
- type: checkboxes
id: validations
attributes:
label: Validations
description: Before submitting the issue, please make sure you have completed the following
options:
- label: I have searched the existing issues/discussions
required: true