From b5da08dd02f200573d77ddd0c68a537b746207f4 Mon Sep 17 00:00:00 2001 From: dev-rahul-arya Date: Mon, 22 Jun 2026 13:54:50 +0530 Subject: [PATCH] Issue Template YAML fixed --- .github/ISSUE_TEMPLATE/bug_report.yml | 141 +++++++++--------- .../documentation_improvement.yml | 109 +++++++------- .github/ISSUE_TEMPLATE/feature_request.yml | 127 ++++++++-------- 3 files changed, 187 insertions(+), 190 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index d53b867..0f02068 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -4,83 +4,82 @@ title: "[Bug]: " labels: ["bug"] body: + - type: markdown + attributes: + value: | + Thank you for taking the time to report a bug. Please provide as much information as possible. -* type: markdown - attributes: - value: | - Thank you for taking the time to report a bug. Please provide as much information as possible. + - type: textarea + id: description + attributes: + label: Bug Description + description: Provide a clear and concise description of the issue. + placeholder: Describe the bug... + validations: + required: true -* type: textarea - id: description - attributes: - label: Bug Description - description: Provide a clear and concise description of the issue. - placeholder: Describe the bug... - validations: - required: true + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: Help us reproduce the issue. + placeholder: | + 1. Go to... + 2. Click on... + 3. Scroll down to... + 4. Observe the issue... + validations: + required: true -* type: textarea - id: steps - attributes: - label: Steps to Reproduce - description: Help us reproduce the issue. - placeholder: | - 1. Go to... - 2. Click on... - 3. Scroll down to... - 4. Observe the issue... - validations: - required: true + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What should happen instead? + validations: + required: true -* type: textarea - id: expected - attributes: - label: Expected Behavior - description: What should happen instead? - validations: - required: true + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened? + validations: + required: true -* type: textarea - id: actual - attributes: - label: Actual Behavior - description: What actually happened? - validations: - required: true + - type: dropdown + id: severity + attributes: + label: Severity + description: How serious is this issue? + options: + - Low + - Medium + - High + - Critical + validations: + required: true -* type: dropdown - id: severity - attributes: - label: Severity - description: How serious is this issue? - options: - - Low - - Medium - - High - - Critical - validations: - required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots / Screen Recording + description: Add screenshots, GIFs, or recordings if applicable. -* type: textarea - id: screenshots - attributes: - label: Screenshots / Screen Recording - description: Add screenshots, GIFs, or recordings if applicable. + - type: input + id: browser + attributes: + label: Browser + placeholder: Chrome, Firefox, Edge, Safari, etc. -* type: input - id: browser - attributes: - label: Browser - placeholder: Chrome, Firefox, Edge, Safari, etc. + - type: input + id: os + attributes: + label: Operating System + placeholder: Windows 11, Ubuntu 24.04, macOS Sequoia, etc. -* type: input - id: os - attributes: - label: Operating System - placeholder: Windows 11, Ubuntu 24.04, macOS Sequoia, etc. - -* type: textarea - id: additional - attributes: - label: Additional Context - description: Any extra information that might help us investigate the issue. + - type: textarea + id: additional + attributes: + label: Additional Context + description: Any extra information that might help us investigate the issue. diff --git a/.github/ISSUE_TEMPLATE/documentation_improvement.yml b/.github/ISSUE_TEMPLATE/documentation_improvement.yml index df5450a..4ddc5e5 100644 --- a/.github/ISSUE_TEMPLATE/documentation_improvement.yml +++ b/.github/ISSUE_TEMPLATE/documentation_improvement.yml @@ -4,58 +4,57 @@ title: "[Docs]: " labels: ["documentation"] body: - -* type: markdown - attributes: - value: | - Help us improve the project's documentation by providing the details below. - -* type: input - id: section - attributes: - label: "Documentation Section" - description: "Which part of the documentation needs improvement?" - placeholder: "README, Installation Guide, API Docs, Contributing Guide, etc." - validations: - required: true - -* type: textarea - id: current-issue - attributes: - label: "Current Issue" - description: "Describe what is unclear, incorrect, outdated, or missing." - placeholder: "The installation instructions are missing..." - validations: - required: true - -* type: textarea - id: suggested-change - attributes: - label: "Suggested Changes" - description: "Explain the changes you would like to see." - placeholder: "Add a section explaining..." - validations: - required: true - -* type: textarea - id: benefits - attributes: - label: "Benefits" - description: "How would this documentation improvement help users or contributors?" - placeholder: "This would make onboarding easier for new contributors..." - -* type: textarea - id: references - attributes: - label: "References / Examples" - description: "Provide links, screenshots, or examples from other projects if applicable." - -* type: checkboxes - id: checks - attributes: - label: "Checklist" - options: - - label: "I have checked that this documentation issue has not already been reported." - required: true - - label: "I am willing to contribute the documentation update myself." - required: false + - type: markdown + attributes: + value: | + Help us improve the project's documentation by providing the details below. + + - type: input + id: section + attributes: + label: "Documentation Section" + description: "Which part of the documentation needs improvement?" + placeholder: "README, Installation Guide, API Docs, Contributing Guide, etc." + validations: + required: true + + - type: textarea + id: current-issue + attributes: + label: "Current Issue" + description: "Describe what is unclear, incorrect, outdated, or missing." + placeholder: "The installation instructions are missing..." + validations: + required: true + + - type: textarea + id: suggested-change + attributes: + label: "Suggested Changes" + description: "Explain the changes you would like to see." + placeholder: "Add a section explaining..." + validations: + required: true + + - type: textarea + id: benefits + attributes: + label: "Benefits" + description: "How would this documentation improvement help users or contributors?" + placeholder: "This would make onboarding easier for new contributors..." + + - type: textarea + id: references + attributes: + label: "References / Examples" + description: "Provide links, screenshots, or examples from other projects if applicable." + + - type: checkboxes + id: checks + attributes: + label: "Checklist" + options: + - label: "I have checked that this documentation issue has not already been reported." + required: true + - label: "I am willing to contribute the documentation update myself." + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index dc74ef5..6e54057 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -4,75 +4,74 @@ title: "[Feature]: " labels: ["enhancement"] body: + - type: markdown + attributes: + value: | + Have an idea to improve the project? We'd love to hear it! -* type: markdown - attributes: - value: | - Have an idea to improve the project? We'd love to hear it! + - type: textarea + id: feature-description + attributes: + label: "Feature/Project Proposal" + description: "Describe the feature, enhancement, or project idea." + placeholder: "I would like to propose..." + validations: + required: true -* type: textarea - id: feature-description - attributes: - label: "Feature/Project Proposal" - description: "Describe the feature, enhancement, or project idea." - placeholder: "I would like to propose..." - validations: - required: true + - type: textarea + id: problem-solved + attributes: + label: "Problem Statement" + description: "What problem does this solve or what limitation does it address?" + placeholder: "Currently..." + validations: + required: true -* type: textarea - id: problem-solved - attributes: - label: "Problem Statement" - description: "What problem does this solve or what limitation does it address?" - placeholder: "Currently..." - validations: - required: true + - type: textarea + id: proposed-solution + attributes: + label: "Proposed Solution" + description: "Describe your suggested solution." + placeholder: "The project could..." + validations: + required: true -* type: textarea - id: proposed-solution - attributes: - label: "Proposed Solution" - description: "Describe your suggested solution." - placeholder: "The project could..." - validations: - required: true + - type: textarea + id: alternatives + attributes: + label: "Alternatives Considered" + description: "Have you considered any alternative approaches?" + placeholder: "Another possible solution is..." -* type: textarea - id: alternatives - attributes: - label: "Alternatives Considered" - description: "Have you considered any alternative approaches?" - placeholder: "Another possible solution is..." + - type: textarea + id: benefits + attributes: + label: "Benefits" + description: "How would this improve the project or user experience?" + placeholder: "This feature would..." -* type: textarea - id: benefits - attributes: - label: "Benefits" - description: "How would this improve the project or user experience?" - placeholder: "This feature would..." + - type: dropdown + id: priority + attributes: + label: "Priority" + description: "How impactful is this feature?" + options: + - Low + - Medium + - High -* type: dropdown - id: priority - attributes: - label: "Priority" - description: "How impactful is this feature?" - options: - - Low - - Medium - - High + - type: textarea + id: additional-context + attributes: + label: "Additional Context" + description: "Add mockups, screenshots, references, or any extra details." -* type: textarea - id: additional-context - attributes: - label: "Additional Context" - description: "Add mockups, screenshots, references, or any extra details." - -* type: checkboxes - id: checks - attributes: - label: "Checklist" - options: - - label: "I have searched existing issues and discussions before creating this request." - required: true - - label: "I am willing to work on this feature if it is approved." - required: false + - type: checkboxes + id: checks + attributes: + label: "Checklist" + options: + - label: "I have searched existing issues and discussions before creating this request." + required: true + - label: "I am willing to work on this feature if it is approved." + required: false