From 591db0ee92b0c2d4576676bbd709a2ec482dfcbe Mon Sep 17 00:00:00 2001 From: sxyazi Date: Fri, 25 Oct 2024 08:56:08 +0800 Subject: [PATCH] chore: add discussion template --- .github/DISCUSSION_TEMPLATE/1-q-a.yml | 54 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug.yml | 43 +++------------------ .github/ISSUE_TEMPLATE/config.yml | 5 ++- .github/ISSUE_TEMPLATE/feature.yml | 18 ++++++++- 4 files changed, 81 insertions(+), 39 deletions(-) create mode 100644 .github/DISCUSSION_TEMPLATE/1-q-a.yml diff --git a/.github/DISCUSSION_TEMPLATE/1-q-a.yml b/.github/DISCUSSION_TEMPLATE/1-q-a.yml new file mode 100644 index 0000000..580387f --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/1-q-a.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index a33878a..0559ee3 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -1,4 +1,4 @@ -name: Bug Report +name: 🐞 Bug Report description: Create a report to help us improve labels: [bug] assignees: [] @@ -15,6 +15,7 @@ body: - Windows WSL - FreeBSD X11 - FreeBSD Wayland + - Android validations: required: true - type: input @@ -29,25 +30,7 @@ body: attributes: label: "`yazi --debug` output" description: Please run `yazi --debug` and paste the debug information here. - value: | -
- - ```sh - ##### ↓↓↓ Paste the output here: ↓↓↓ ##### - - - ``` - -
- 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 + render: Shell validations: required: true - type: textarea @@ -59,28 +42,14 @@ body: validations: required: true - type: textarea - id: expected + id: reproducer attributes: - label: Expected Behavior - description: A clear and concise description of what you expected to happen - validations: - required: true - - type: textarea - id: to_repro - attributes: - label: To Reproduce - description: Steps to reproduce the behavior + label: Minimal reproducer + description: A [minimal reproducer](https://stackoverflow.com/help/minimal-reproducible-example) is required, otherwise the issue might be closed without further notice. placeholder: | Please include as much information as possible that can help to reproduce and understand the issue. validations: 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 id: other attributes: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index f8c4807..f17334a 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,8 @@ blank_issues_enabled: false 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 about: If you'd prefer more realtime conversation with the community diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index c9e9fb8..190df38 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -1,8 +1,16 @@ -name: Feature Request +name: 💡 Feature Request description: Suggest an idea for this project labels: [feature] assignees: [] 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 id: problem attributes: @@ -29,3 +37,11 @@ body: attributes: label: Additional context 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