Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
adeyinkaoresanya authored Mar 27, 2024
1 parent 76de8c7 commit 14983ab
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 15 deletions.
25 changes: 14 additions & 11 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,41 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
title: 'Please provide a concise and informative title that summarizes the issue:
e.g. [BUG]<X> not working for <Y>'
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.
_A clear and concise description of what the bug is. Be specific and clear about what you were trying to do when the bug occurred._

**To Reproduce**
Steps to reproduce the behavior:
**Steps To Reproduce**
_List the exact steps someone can take to reproduce the issue._
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.
_A clear and concise description of what you expected to happen when performing the actions outlined in the "Steps to Reproduce" section._

**Screenshots**
If applicable, add screenshots to help explain your problem.
**Screenshots/screen recordings**
_If applicable, add screenshots/screen recordings to help explain your problem._

**Desktop (please complete the following information):**
**Desktop specifications**
_Please complete the following information if applicable):_
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
**Smartphone specifications**
_Please complete the following information if applicable):_
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
• Provide any additional information that might help understand the issue. This could include links to relevant code snippets, configuration files, or other resources.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/doc-feedback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Doc feedback
about: Create a detailed report to help us improve
title: 'Briefly describe the improvement you''re requesting e.g. [DOC]: Improve clarity
of X'
labels: ''
assignees: ''

---

**Description**

Clearly explain the problem with the documentation. If possible, provide screenshots or code snippets to illustrate the issue.

**Affected Documentation**
Specify the name or location of the documentation affected by the issue. This could be a specific file (e.g. contributing.md) or a section within a larger document.

**Suggested improvement**

Propose a solution for fixing the documentation issue. This could be a revised text, a clearer explanation, or a link to a relevant resource.

**Additional Information**

Include any other information that might be helpful in understanding the issue.
12 changes: 8 additions & 4 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
title: 'Please provide a concise and informative title that summarizes the issue:
e.g. [FEATURE]: [Describe the desired feature]'
labels: enhancement
assignees: ''

---
Expand All @@ -11,10 +12,13 @@ assignees: ''
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.
A clear and concise description of what you want to happen. Be as specific as possible, including details like user interface elements or functionalities.

**Benefit**
Highlight the positive impact on users or the development process.

**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.
Add any other context or screenshots about the feature request here. You can include any relevant resources, like code snippets, mockups, or references to similar features in other projects.

0 comments on commit 14983ab

Please sign in to comment.