From 9692b7b9b529270829cc4d903593c2f0cd3d28ba Mon Sep 17 00:00:00 2001 From: sxyazi Date: Mon, 23 Oct 2023 19:38:45 +0800 Subject: [PATCH] chore: add issue templates --- .github/ISSUE_TEMPLATE/bug.yml | 72 ++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++++ .github/ISSUE_TEMPLATE/feature.yml | 36 +++++++++++++++ 3 files changed, 116 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 000000000..87a580a07 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,72 @@ +name: Bug Report +description: Create a report to help us improve +labels: [bug] +assignees: [] +body: + - type: dropdown + id: os + attributes: + label: What Operating System(s) are you running Yazi on? + multiple: true + options: + - Linux X11 + - Linux Wayland + - macOS + - Windows + validations: + required: true + - type: input + id: version + attributes: + label: Yazi version + description: Please do a `yazi -V` and paste the output here. + placeholder: "ex: yazi 0.1.5" + validations: + required: true + - type: dropdown + id: tried_main + attributes: + label: Did you try the latest main branch to see if the problem has already been fixed? + options: + - Yes, and the problem is still present + - No, and I'll explain why below + validations: + required: true + - type: textarea + id: description + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is + placeholder: Tell us what happened + validations: + required: true + - type: textarea + id: expected + 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 + 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: + 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. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..0cbb58a8c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - 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 + 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 new file mode 100644 index 000000000..8e11a9efc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,36 @@ +name: Feature Request +description: Suggest an idea for this project +labels: [enhancement] +assignees: [] +body: + - type: textarea + id: problem + attributes: + label: Is your feature request related to a problem? Please describe + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true + - type: checkboxes + id: contribute + attributes: + label: Will you be willing to contribute this feature? + description: The feature has a much higher chance of completion if you are willing to get involved! + options: + - label: Yes, I will try to implement it + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + - type: textarea + id: context + attributes: + label: Additional context + description: Add any other context or screenshots about the feature request here.