From e6232fd541af66542d8f2705e3ca28b448e2bddd Mon Sep 17 00:00:00 2001 From: utsavdotdev <95236817+utsavdotdev@users.noreply.github.com> Date: Thu, 17 Oct 2024 20:27:23 +0545 Subject: [PATCH] feat(github): Replace incomplete issue template form with new one --- .github/ISSUE_TEMPLATE/BUG_REPORT.yaml | 66 -------------- .github/ISSUE_TEMPLATE/bug_report.yml | 97 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/docs_improvement.yml | 46 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ----- .github/ISSUE_TEMPLATE/feature_request.yml | 57 ++++++++++++ 6 files changed, 205 insertions(+), 86 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.yaml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/docs_improvement.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml b/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml deleted file mode 100644 index 24e376c..0000000 --- a/.github/ISSUE_TEMPLATE/BUG_REPORT.yaml +++ /dev/null @@ -1,66 +0,0 @@ -name: Bug Report -description: File a bug report. -title: "[Bug]: " -labels: ["bug", "triage"] -projects: ["octo-org/1", "octo-org/44"] -assignees: - - octocat -body: - - type: markdown - attributes: - value: | - Thanks for taking the time to fill out this bug report! - - type: input - id: contact - attributes: - label: Contact Details - description: How can we get in touch with you if we need more info? - placeholder: ex. email@example.com - validations: - required: false - - type: textarea - id: what-happened - attributes: - label: What happened? - description: Also tell us, what did you expect to happen? - placeholder: Tell us what you see! and steps to reproduce the issue. - value: "A bug happened! " - validations: - required: true - - type: input - id: os - attributes: - label: OS - description: Specify the operating system (e.g., Mac OS, Windows, Linux). - - - type: input - id: browsers - attributes: - label: Browsers - description: Specify the browsers (e.g., Firefox, Chrome, Safari, Microsoft Edge). - - # - type: dropdown - # id: browsers - # attributes: - # label: What browsers are you seeing the problem on? - # multiple: true - # options: - # - Firefox - # - Chrome - # - Safari - # - Microsoft Edge - - - type: textarea - id: logs - attributes: - label: Relevant log output - description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. - render: shell - # - type: checkboxes - # id: terms - # attributes: - # label: Code of Conduct - # description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com). - # options: - # - label: I agree to follow this project's Code of Conduct - # required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..0adcc55 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,97 @@ +name: "🐛 Bug Report" +description: "Submit a bug report to help us improve" +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: We value your time and your efforts to submit this bug report is appreciated. 🙏 + + - type: textarea + id: description + validations: + required: true + attributes: + label: "📜 Description" + description: "A clear and concise description of what the bug is." + placeholder: "It bugs out when ..." + + - type: textarea + id: steps-to-reproduce + validations: + required: true + attributes: + label: "👟 Reproduction steps" + description: "How do you trigger this bug? Please walk us through it step by step." + placeholder: "1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error" + + - type: textarea + id: expected-behavior + validations: + required: true + attributes: + label: "👍 Expected behavior" + description: "What did you think should happen?" + placeholder: "It should ..." + + - type: textarea + id: actual-behavior + validations: + required: true + attributes: + label: "👎 Actual Behavior with Screenshots" + description: "What did actually happen? Add screenshots, if applicable." + placeholder: "It actually ..." + + - type: dropdown + id: operating-system + attributes: + label: "💻 Operating system" + description: "What OS is your app running on?" + options: + - Linux + - MacOS + - Windows + - Something else + validations: + required: true + + - type: textarea + id: additional-context + validations: + required: false + attributes: + label: "📃 Provide any additional context for the Bug." + description: "Add any other context about the problem here." + placeholder: "It actually ..." + + - type: textarea + id: logs + validations: + required: false + attributes: + label: 📖 Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "👀 Have you spent some time to check if this bug has been raised before?" + options: + - label: "I checked and didn't find similar issue" + required: true + + - type: dropdown + id: willing-to-submit-pr + attributes: + label: 🔗 Are you willing to submit PR? + description: This is absolutely not required, but we are happy to guide you in the contribution process. + options: + - "Yes, I am willing to submit a PR!" + - "No" + validations: + required: true \ 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 0000000..3fe46d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Have Question? + url: https://discord.com/invite/KJWxDPBRUj + about: Join Official Discord server \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/docs_improvement.yml b/.github/ISSUE_TEMPLATE/docs_improvement.yml new file mode 100644 index 0000000..98df0ed --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs_improvement.yml @@ -0,0 +1,46 @@ +name: "📝 Docs Improvement" +description: "Suggest improvements or additions to the documentation" +title: "[Docs]: " +labels: ["documentation"] +body: + - type: markdown + attributes: + value: Thanks for taking the time to help improve our documentation! Please provide the following details + + - type: input + id: current_section + attributes: + label: "Current Section" + description: "Which section of the documentation needs improvement?" + placeholder: "e.g., Installation Guide" + + - type: textarea + id: improvement_suggestion + attributes: + label: "Improvement Suggestion" + description: "Describe the improvement or addition you are suggesting." + placeholder: "e.g., Add more details about setting up the environment." + + - type: textarea + id: additional_context + attributes: + label: "Additional Context" + description: "Any additional context or information that might be helpful." + placeholder: "e.g., Links to related documentation, screenshots, etc." + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "👀 Have you spent some time to check if this issue has been raised before?" + options: + - label: "I checked and didn't find similar issue" + required: true + - type: dropdown + id: willing-to-submit-pr + attributes: + label: Are you willing to submit PR? + description: This is absolutely not required, but we are happy to guide you in the contribution process. + options: + - "Yes I am willing to submit a PR!" + - "No" + validations: + required: true \ 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 aacda9e..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request 🚀 -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**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/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..a8accb3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,57 @@ +name: 🚀 Feature +description: "Submit a proposal for a new feature" +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: We value your time and your efforts to submit this feature request is appreciated. 🙏 + - type: textarea + id: feature-description + validations: + required: true + attributes: + label: "🔖 Feature description" + description: "A clear and concise description of what the feature is." + placeholder: "You should add ..." + - type: textarea + id: pitch + validations: + required: true + attributes: + label: "🎤 Why is this feature needed ?" + description: "Please explain why this feature should be implemented and how it would be used. Add examples, if applicable." + placeholder: "In my use-case, ..." + - type: textarea + id: solution + validations: + required: true + attributes: + label: "✌️ How do you aim to achieve this?" + description: "A clear and concise description of what you want to happen." + placeholder: "I want this feature to, ..." + - type: textarea + id: alternative + validations: + required: false + attributes: + label: "🔄️ Additional Information" + description: "A clear and concise description of any alternative solutions or additional solutions you've considered." + placeholder: "I tried, ..." + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "👀 Have you spent some time to check if this feature request has been raised before?" + options: + - label: "I checked and didn't find similar issue" + required: true + - type: dropdown + id: willing-to-submit-pr + attributes: + label: Are you willing to submit PR? + description: This is absolutely not required, but we are happy to guide you in the contribution process. + options: + - "Yes I am willing to submit a PR!" + - "No" + validations: + required: true \ No newline at end of file