From 81dfb9bbd2568a8ac9ff7235d7163cf17fe32993 Mon Sep 17 00:00:00 2001 From: Mir Sazzat Hossain Date: Sat, 14 Sep 2024 10:50:37 +0000 Subject: [PATCH] feat: Add bug report and feature request issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 37 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 31 +++++++++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..6494b3a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +## Bug Report + +**Describe the Bug** + +A clear and concise description of what the bug is. + +**Steps to Reproduce** + +1. **Step 1**: Describe the first step to reproduce the bug. +2. **Step 2**: Describe the next step, and so on. +3. **Step 3**: Include any additional steps needed to reproduce the issue. + +**Expected Behavior** + +Describe what you expected to happen. + +**Actual Behavior** + +Describe what actually happened, including any error messages or unexpected behavior. + +**Screenshots/Logs** + +If applicable, add screenshots or logs that show the bug. This can help with diagnosing the issue. + +**Environment** + +- **Operating System**: (e.g., Windows 10, macOS 11) +- **Browser/Platform**: (e.g., Chrome 91, iOS 14) +- **Version**: (e.g., v1.2.3) + +**Additional Information** + +Include any other information that may be relevant to the issue, such as related issues, temporary workarounds, or changes in recent versions. + +--- + +Thank you for reporting this bug. We will investigate it as soon as possible! diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..5c88d2a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,31 @@ +## Feature Request + +**Feature Description** + +Provide a clear and concise description of the feature you would like to see. + +**Use Case** + +Explain the context in which this feature will be used. How will it benefit users or solve a specific problem? + +**Proposed Implementation** + +Outline your suggested approach for implementing this feature. Include any specific ideas, designs, or references. + +**Additional Information** + +- **Dependencies**: Are there any dependencies or related features that need to be considered? +- **Impact**: What impact will this feature have on the current system or workflow? +- **Acceptance Criteria**: What conditions must be met for this feature to be considered complete? + +**Screenshots/Mockups** + +If applicable, attach any screenshots or mockups that help illustrate your request. + +**Additional Comments** + +Any other comments or information relevant to the feature request. + +--- + +Thank you for contributing to [Project Name]!