From 02cbf3dfa07154bc5b3d7f16f152f1ceeccfd8f1 Mon Sep 17 00:00:00 2001 From: Sachin M Mane <54999683+sachinmmane@users.noreply.github.com> Date: Tue, 31 Oct 2023 12:24:51 +0530 Subject: [PATCH] =?UTF-8?q?chore:=20=C2=A0Improved=20the=20issue=20templat?= =?UTF-8?q?es=20with=20issue=20forms=20(supported=20via`yml`=C2=A0)=20(#61?= =?UTF-8?q?2)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit GitHub supports the issue forms [1]. [1] https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms This feature allows users to create issues using a structured and visually appealing form. This functionality is facilitated through a  file for the issue template. Added the issue template for bug report, feature request, and improvement by adding respective file. Also, removed previous file which is no longer needed --- .github/ISSUE_TEMPLATE/bug-report.md | 50 ---------------------- .github/ISSUE_TEMPLATE/bug-report.yml | 47 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 41 ------------------ .github/ISSUE_TEMPLATE/feature-request.yml | 35 +++++++++++++++ .github/ISSUE_TEMPLATE/improvement.md | 41 ------------------ .github/ISSUE_TEMPLATE/improvement.yml | 35 +++++++++++++++ 6 files changed, 117 insertions(+), 132 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/improvement.md create mode 100644 .github/ISSUE_TEMPLATE/improvement.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index d12bdad59..000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -name: Bug Report -about: Create a bug report to help us improve ---- - - - -## Issue Description - - - -## Steps to Reproduce - - - - -1. Step 1 -2. Step 2 -3. ... - -## Expected Behavior - - - -## Current Behavior - - - -## Screenshots (optional) - - - -## Environment - - - -- OS: [e.g., Windows 10] -- Browser: [e.g., Chrome, Firefox] -- Version: [e.g., 2.0.1] - -## Checklist - - - - -- [ ] I have searched the existing issues to make sure this is not a duplicate. -- [ ] I have provided steps to reproduce the issue. -- [ ] I have included relevant environment information. -- [ ] I have included any relevant screenshots. -- [ ] I understand that this is a voluntary contribution and that there is no guarantee of resolution. diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..f5fdb5166 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,47 @@ +name: "Bug Report" +labels: "bug" +description: Create a bug report to help us improve +body: + - type: markdown + attributes: + value: + Thank you for reporting an issue. + Please fill in as much of the form below as you're able to. + - type: textarea + attributes: + label: Issue Description + description: Please provide a clear and concise description of the problem. + - type: textarea + attributes: + label: Steps to Reproduce + description: Please provide step-by-step instructions to reproduce the issue. Include code snippets, error messages, and any other relevant information. + - type: textarea + attributes: + label: Expected Behavior + description: Describe what you expected to happen. + - type: textarea + attributes: + label: Current Behavior + description: Describe what is currently happening. + - type: textarea + attributes: + label: Screenshots (optional) + description: If applicable, add screenshots to help explain the issue. + - type: input + attributes: + label: Operating System [e.g., Windows 10] + - type: input + attributes: + label: Browser [e.g., Chrome, Firefox] + - type: input + attributes: + label: Version [e.g., 2.0.1] + - type: checkboxes + attributes: + label: Please check the boxes that apply to this issue report. + options: + - label: I have searched the existing issues to make sure this is not a duplicate. + - label: I have provided steps to reproduce the issue. + - label: I have included relevant environment information. + - label: I have included any relevant screenshots. + - label: I understand that this is a voluntary contribution and that there is no guarantee of resolution. \ 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 a850a7a9a..000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: Feature Request -about: Suggest a new idea or enhancement for this project ---- - - - -## Feature Description - - - - -## Use Case - - - - -## Proposed Solution - - - - -## Alternatives (optional) - - - - -## Additional Context - - - -## Checklist - - - - -- [ ] I have searched the existing feature requests to make sure this is not a duplicate. -- [ ] I have provided a detailed description of the requested feature. -- [ ] I have explained the use case or scenario for this feature. -- [ ] I have included any relevant technical details or design suggestions. -- [ ] I understand that this is a suggestion and that there is no guarantee of implementation. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..f323f9475 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,35 @@ +name: "Feature Request" +description: Suggest a new idea or enhancement for this project +body: + - type: markdown + attributes: + value: Please provide a clear and concise title for your feature request + - type: textarea + attributes: + label: Feature Description + description: Describe the feature you are requesting in detail. Explain what problem it solves or what value it adds to the project. + - type: textarea + attributes: + label: Use Case + description: Provide a scenario or use case where this feature would be beneficial. Explain how users would interact with this feature and why it's important. + - type: textarea + attributes: + label: Proposed Solution + description: If you have an idea of how this feature could be implemented, describe it here. Include any technical details, UI/UX considerations, or design suggestions. + - type: textarea + attributes: + label: Alternatives (optional) + description: Are there any alternative ways to achieve the same goal? Describe other approaches that could be considered if this feature is not implemented. + - type: textarea + attributes: + label: Additional Context + description: Add any additional context or information that might be relevant to the feature request. + - type: checkboxes + attributes: + label: Please check the boxes that apply to this feature request. + options: + - label: I have searched the existing feature requests to make sure this is not a duplicate. + - label: I have provided a detailed description of the requested feature. + - label: I have explained the use case or scenario for this feature. + - label: I have included any relevant technical details or design suggestions. + - label: I understand that this is a suggestion and that there is no guarantee of implementation. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/improvement.md b/.github/ISSUE_TEMPLATE/improvement.md deleted file mode 100644 index 709d3441f..000000000 --- a/.github/ISSUE_TEMPLATE/improvement.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: General Improvement -about: Suggest a minor enhancement or improvement for this project ---- - - - -## Improvement Description - - - - -## Rationale - - - - -## Proposed Solution - - - - -## Alternatives (optional) - - - - -## Additional Context - - - -## Checklist - - - - -- [ ] I have searched the existing issues and improvement suggestions to avoid duplication. -- [ ] I have provided a clear description of the improvement being suggested. -- [ ] I have explained the rationale behind this improvement. -- [ ] I have included any relevant technical details or design suggestions. -- [ ] I understand that this is a suggestion and that there is no guarantee of implementation. diff --git a/.github/ISSUE_TEMPLATE/improvement.yml b/.github/ISSUE_TEMPLATE/improvement.yml new file mode 100644 index 000000000..bebcb4cb5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improvement.yml @@ -0,0 +1,35 @@ +name: "General Improvement" +description: Suggest a minor enhancement or improvement for this project +body: + - type: markdown + attributes: + value: Please provide a clear and concise title for your improvement suggestion + - type: textarea + attributes: + label: Improvement Description + description: Describe the improvement you are suggesting in detail. Explain what specific aspect of the project it addresses or enhances. + - type: textarea + attributes: + label: Rationale + description: Explain why this improvement would be beneficial. Share any context, pain points, or reasons for suggesting this change. + - type: textarea + attributes: + label: Proposed Solution + description: If you have a suggestion for how this improvement could be implemented, describe it here. Include any technical details, design suggestions, or other relevant information. + - type: textarea + attributes: + label: Alternatives (optional) + description: Are there any alternative approaches to achieve the same improvement? Describe other ways to address the issue or enhance the project. + - type: textarea + attributes: + label: Additional Context + description: Add any additional context or information that might be relevant to the improvement suggestion. + - type: checkboxes + attributes: + label: Please check the boxes that apply to this improvement suggestion. + options: + - label: I have searched the existing issues and improvement suggestions to avoid duplication. + - label: I have provided a clear description of the improvement being suggested. + - label: I have explained the rationale behind this improvement. + - label: I have included any relevant technical details or design suggestions. + - label: I understand that this is a suggestion and that there is no guarantee of implementation. \ No newline at end of file