From 3b4fab5aaefc9f1b4c540122d9ea45877f8b1c16 Mon Sep 17 00:00:00 2001 From: Kingkor Roy Tirtho Date: Tue, 9 Aug 2022 09:36:34 +0600 Subject: [PATCH] docs: add github issue form template for bugs and QnA --- .github/ISSUE_TEMPLATE/bug_report.md | 41 ------------ .github/ISSUE_TEMPLATE/bug_report.yml | 91 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ 3 files changed, 96 insertions(+), 41 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index a90be0b8..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Installation Source/Method** -- Package Manager: -- Community Repo: -- Binary Source: - -**Desktop (please complete the following information):** - - OS: [e.g. archlinux] - - Version [e.g. v1.0.0] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Version [e.g. v1.0.0] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..cc9ee307 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,91 @@ +name: 🐛 Bug +description: Report a bug or incorrect behavior +title: "[Bug] " +labels: + - bug + - good first issue +assignees: + - KRTirtho +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + - type: textarea + attributes: + label: Current Behavior + description: Tell us what you're experiencing concisely. + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: Let us know what you expected to happen concisely. + validations: + required: true + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: false + - type: input + attributes: + label: Spotube Version + description: In which version of Spotube did you encounter this bug? + placeholder: e.g. v2.3.0 + - type: dropdown + attributes: + label: Operating System + description: In which OS you're experiencing the bug? + multiple: false + options: + - "Android" + - "Linux" + - "Windows" + - "Mac OS" + validations: + required: true + - type: input + attributes: + label: Linux Distribution (if applicable) + description: Tell us in what Linux Distribution you're experiencing the bug. + placeholder: Arch Linux + validations: + required: false + - type: input + attributes: + label: Operating System Version + description: In which version of your OS you're experiencing the bug? + placeholder: e.g. Android 10 + validations: + required: true + - type: dropdown + attributes: + label: Installation Source + description: How did you install Spotube? + multiple: false + options: + - "Official Website (spotube.netlify.app)" + - "Github Release (Binary)" + - "Github Actions (Nightly Binary)" + - "F-Droid (Android)" + - "Arch User Repository (AUR)" + - "Flathub (Flatpak)" + - "chocolatey (Windows)" + - "WinGet (Windows)" + - "Scoop (Windows)" + validations: + required: true + + - type: markdown + attributes: + value: Additional information diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..77189e7d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://github.com/KRTirtho/spotube/discussions/new?category=q-a + about: The place for questions, support and feature requests