From 3fdbbfe915717f2ddd0ba891b4d19354e3136ff9 Mon Sep 17 00:00:00 2001 From: sxyazi Date: Fri, 2 Aug 2024 17:38:21 +0800 Subject: [PATCH] chore: update issue templates --- .github/ISSUE_TEMPLATE/bug.yml | 22 ++++------------------ .github/ISSUE_TEMPLATE/config.yml | 7 +++++-- .github/ISSUE_TEMPLATE/feature.yml | 29 ++++++++++++++++++++++++++++- 3 files changed, 37 insertions(+), 21 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index a33878ad..db235f59 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: [] @@ -59,28 +59,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 0cbb58a8..9976ab8a 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,11 @@ blank_issues_enabled: false contact_links: - - name: Discord server / Telegram group + - name: 📝 Documentation Improvement + url: https://github.com/yazi-rs/yazi-rs.github.io + about: If you'd like to help improve the documentation + - name: 🌐 Discord Server / Telegram Group url: https://github.com/sxyazi/yazi#discussion about: If you'd prefer more realtime conversation with the community - - name: GitHub Discussions + - name: 💬 GitHub Discussions url: https://github.com/sxyazi/yazi/discussions about: When you have questions that are not bug reports or feature requests diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index c9e9fb82..fac38dc9 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -1,8 +1,25 @@ -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. + value: | +
+ + ```sh + ##### ↓↓↓ Paste the output here: ↓↓↓ ##### + + + ``` + +
+ validations: + required: true - type: textarea id: problem attributes: @@ -29,3 +46,13 @@ 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 + required: true + - label: The latest nightly build of Yazi doesn't already have this feature + required: true