Skip to content

Commit

Permalink
feat: Add bug report and feature request issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
mirsazzathossain committed Sep 14, 2024
1 parent 0267301 commit 81dfb9b
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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!
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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]!

0 comments on commit 81dfb9b

Please sign in to comment.