From 364076c25e3b8744b2fe2da24e83b8ce93d834f0 Mon Sep 17 00:00:00 2001 From: MyDrift Date: Tue, 25 Feb 2025 18:29:18 +0100 Subject: [PATCH] [GHTemplates] Use new preview of Issue templates (#3202) * use new issue preview - convert existing issue templates to new template style - move issue validation to start - add important section at start - improve checkbox UX - improve wording a bit - add config to link discord & remove blank issues * remove description --- .github/ISSUE_TEMPLATE/bug_report.md | 30 ---------- .github/ISSUE_TEMPLATE/bug_report.yaml | 62 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature_request.md | 24 -------- .github/ISSUE_TEMPLATE/feature_request.yaml | 57 +++++++++++++++++++ 5 files changed, 124 insertions(+), 54 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 063c005f..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: 'bug' -assignees: '' ---- - -## Describe the bug - - -## Steps to reproduce -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See the error. - -## Expected behavior - - -## Screenshots - - -## Additional context - - -## Issue validation -- [ ] I checked for duplicate issues. -- [ ] I checked for already existing discussions. -- [ ] I checked for an already existing pull request addressing the issue. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..a17a517e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,62 @@ +name: "Bug report" +description: "Report a bug to help us identify and fix issues in the project." +labels: ["bug"] + +body: + - type: markdown + attributes: + value: | + # 🐞 **Issue Report** + Thank you for taking the time to report an issue! Please provide as much detail as possible to help us address the problem efficiently. + + ## ⚠️ **IMPORTANT** + - 🛠️ **Supported environments only:** We only support Windows 11. Custom ISOs that are not made using Microwin are not supported. + - 💡 For general questions, use the [Discussions section](https://github.com/Christitustech/winutil/discussions) or join our Community-driven [Discord Server](https://discord.gg/RUbZUZyByQ). + + - type: checkboxes + attributes: + label: ⚙️ Issue Checklist + options: + - label: I have read the guidelines. + - label: I checked for duplicate issues. + - label: I searched for existing discussions. + - label: I checked for an existing pull request that addresses this issue. + validations: + required: true + + - type: input + id: affected_part + attributes: + label: 📜 What part of Winutil are you having issues with? + placeholder: "e.g., Microwin, Tweaks, etc." + validations: + required: true + + - type: textarea + id: issue_description + attributes: + label: 📝 Provide a clear and concise description of the issue. + validations: + required: true + + - type: textarea + id: steps_to_reproduce + attributes: + label: 🔄 Steps to reproduce the issue. + placeholder: "e.g., Step 1: ..., Step 2: ..." + validations: + required: true + + - type: textarea + id: error_output + attributes: + label: ❌ Paste the full error output (if available). + placeholder: "Include any relevant logs or error messages." + + - type: textarea + id: additional_context + attributes: + label: 🖼️ Additional context. + placeholder: "Include screenshots, code blocks (use triple backticks ```), or any other relevant information." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..024473d8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: 💻 Community Discord + url: https://discord.gg/RUbZUZyByQ + about: Join our Community Discord server to chat with other users in the Winutil community. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index f9874142..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: 'enhancement' -assignees: '' ---- - -## Is your feature request related to a problem? Please describe - - -## Describe the solution you'd like - - -## Describe alternatives you've considered - - -## Additional context - - -## Issue validation -- [ ] I checked for duplicate issues. -- [ ] I checked for already existing discussions. -- [ ] I checked for an already existing pull request addressing the issue. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..d32fae1e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,57 @@ +name: "Feature request" +description: "Suggest a new feature or improvement for the project." +labels: ["enhancement"] + +body: + - type: markdown + attributes: + value: | + # ✨ **Feature request** + Thank you for taking the time to suggest a feature! Please provide as much detail as possible to help us understand and evaluate your request. + + ## ⚠️ **IMPORTANT** + - 🛠️ **Supported environments only:** We only support Windows 11. + - 💡 For general questions, use the [Discussions section](https://github.com/Christitustech/winutil/discussions) or join our Community-driven [Discord Server](https://discord.gg/RUbZUZyByQ). + + - type: checkboxes + attributes: + label: ⚙️ Issue Checklist + options: + - label: I have read the guidelines. + - label: I checked for duplicate issues. + - label: I searched for existing discussions. + - label: I checked for an existing pull request that addresses this request. + validations: + required: true + + - type: textarea + id: problem_statement + attributes: + label: ❓ Is your feature request related to a problem? + placeholder: "Provide a clear and concise description of the issue you're facing. Example: 'I'm always frustrated when [...]'" + validations: + required: false + + - type: textarea + id: proposed_solution + attributes: + label: 💡 Describe the solution you'd like + placeholder: "Provide 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 + placeholder: "Provide details on any alternative solutions or features you've thought about." + validations: + required: false + + - type: textarea + id: additional_context + attributes: + label: 🖼️ Additional context + placeholder: "Include screenshots, code blocks (use triple backticks ```), or any other relevant information." + validations: + required: false \ No newline at end of file