From 6fd73e8724dff86f53d9df94f702cd1405ec12ee Mon Sep 17 00:00:00 2001 From: Erik Balchunas Date: Fri, 31 Oct 2025 12:06:03 +0000 Subject: [PATCH] Update Issue Templates from MD to YAML (Issue Form Templates) (#625) * Replace Markdown issue Templates with YAML Templates updated the label text, alongside adding the relevant links field to the feature requests template. * add device field to issue reports --------- Co-authored-by: Violet Caulfield <42452695+anultravioletaurora@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/01_report_issue.yaml | 120 ++++++++++++++++++ .../ISSUE_TEMPLATE/02_request_feature.yaml | 64 ++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 + .github/ISSUE_TEMPLATE/feature_request.md | 21 --- .../{bug_report.md => issue_template.md} | 0 5 files changed, 189 insertions(+), 21 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/01_report_issue.yaml create mode 100644 .github/ISSUE_TEMPLATE/02_request_feature.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md rename .github/ISSUE_TEMPLATE/{bug_report.md => issue_template.md} (100%) diff --git a/.github/ISSUE_TEMPLATE/01_report_issue.yaml b/.github/ISSUE_TEMPLATE/01_report_issue.yaml new file mode 100644 index 00000000..4e298f99 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_report_issue.yaml @@ -0,0 +1,120 @@ +name: Report an Issue +description: Did you experience an issue using Jellify? Please report it here. +title: "[BUG] " +labels: ["bug"] +type: bug +assignees: + - anultravioletaurora +body: + - type: markdown + attributes: + value: "Please provide the following information to help us investigate and resolve the issue." + + - type: input + id: summary + attributes: + label: Describe the issue. + description: A clear and concise summary of the issue you are experiencing. + placeholder: "When I do X, Y happens instead of Z. This causes..." + validations: + required: true + + - type: textarea + id: reproduction_steps + attributes: + label: Can the issue be reproduced? + description: "If you can reproduce the issue, please provide step-by-step instructions below. Otherwise, leave this field blank." + placeholder: | + 1. + 2. + 3. + ... + validations: + required: false + + - type: input + id: expected_behavior + attributes: + label: What is the expected behavior? + description: What did you expect to happen in an ideal situation? + placeholder: "X should happen when Y is done." + validations: + required: true + + - type: textarea + id: actual_behavior + attributes: + label: What actually happened in this case? + description: Try to provide a detailed description if you can. + placeholder: "When I did Y, Z happened instead." + validations: + required: true + + - type: dropdown + id: os-types + attributes: + label: What operating system(s) were you using when the issue occurred? + description: Which operating systems did the issue happen? Please select all that apply. + multiple: true + options: + - label: Android + - label: iOS + - label: iPadOS + validations: + required: true + + - type: input + id: device-model + attributes: + label: Which device(s) were you using when the issue occurred? + description: Please specify the model of your device. + placeholder: "Google Pixel 7 / iPhone 14 Pro" + validations: + required: true + + - type: input + id: os-version + attributes: + label: Which OS version(s) did you experience this on? + description: Please specify the version of your operating system. + placeholder: "Android 16 / iOS 26" + validations: + required: true + + - type: input + id: jellify-version + attributes: + label: Which version of Jellify (and OTA Version, if applicable)? + description: Which version of Jellify are you using? You can find this in the app settings. You can find this in Settings -> About. + placeholder: "Jellify 0.19.0" + validations: + required: true + + - type: dropdown + id: version + attributes: + label: Which distribution are you using? + description: As Jellify is distributed on multiple platforms, please select which version you are using. + options: + - Google Play Store / Apple App Store + - GitHub Releases + default: 0 + validations: + required: true + + - type: textarea + id: additional_info + attributes: + label: Any additional information goes here. + description: Any additional information, logs, or screenshots that may help in diagnosing the issue. + placeholder: "Provide any additional information here." + validations: + required: false + + - type: input + id: relevant_links + attributes: + label: If there any relevant links, please provide them here. + description: Links to Discord messages, GitHub issues, or other resources related to this issue. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/02_request_feature.yaml b/.github/ISSUE_TEMPLATE/02_request_feature.yaml new file mode 100644 index 00000000..a8a52b2a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02_request_feature.yaml @@ -0,0 +1,64 @@ +name: Request a Feature +description: Have an idea for a new feature or improvement? We'd love to hear it! +title: "[FEATURE] " +labels: ["enhancement"] +type: feature +assignees: + - anultravioletaurora +body: + - type: markdown + attributes: + value: "Please provide the following information to help us understand and evaluate your feature request." + + - type: input + id: feature_summary + attributes: + label: Summarize the requested feature. + description: A clear and concise summary of the feature you are requesting. Be sure to provide more details in the next section. + placeholder: "Jellify would benefit from a feature that..." + validations: + required: true + + - type: textarea + id: problem_description + attributes: + label: Is there a problem this feature solves? + description: If this feature is solving an existing problem, please describe context and details. + placeholder: "This feature would help by..." + validations: + required: false + + - type: textarea + id: proposed_solution + attributes: + label: Describe your solution in as much detail as possible. + description: Describe your proposed solution and how it would work + placeholder: "The feature could work by..." + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Have you considered any alternatives? + description: What alternative solutions have you considered? + placeholder: "The alternatives I have considered are..." + validations: + required: false + + - type: textarea + id: additional_info + attributes: + label: Any additional information goes here. + description: Any additional information, logs, or screenshots that may help in understanding your feature request. + placeholder: "Provide any additional information here." + validations: + required: false + + - type: input + id: relevant_links + attributes: + label: If there any relevant links, please provide them here. + description: Links to Discord messages, GitHub issues, or other resources related to this issue. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..02ce8634 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Discord Server + url: https://discord.gg/jellify + about: Please ask and answer questions here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index ba2274e0..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for Jellify -title: "[FEATURE]" -type: feature -labels: enhancement -assignees: anultravioletaurora - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/issue_template.md similarity index 100% rename from .github/ISSUE_TEMPLATE/bug_report.md rename to .github/ISSUE_TEMPLATE/issue_template.md