From 6d975e4fe07b09bf21b2865987514a0fdcfbaa7d Mon Sep 17 00:00:00 2001 From: Rotimi Best Date: Thu, 23 Nov 2023 23:00:59 +0000 Subject: [PATCH] feat: implement issue template --- .github/ISSUE_TEMPLATE/bug-report.yml | 48 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 35 ++++++++++++++++ .github/ISSUE_TEMPLATE/improvement.yml | 35 ++++++++++++++++ 3 files changed, 118 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/improvement.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..141bb14b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,48 @@ +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: Environment (locally, production, selfhosted) + description: If applicable, describe the environment in which the issue occurs. + - 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. + - label: I want to work on creating a PR for this issue if approved diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..ab21e882 --- /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. diff --git a/.github/ISSUE_TEMPLATE/improvement.yml b/.github/ISSUE_TEMPLATE/improvement.yml new file mode 100644 index 00000000..058a025e --- /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.