Skip to content

Commit

Permalink
Issue Templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Bashamega committed Aug 14, 2024
1 parent c6b0622 commit 72a01fa
Show file tree
Hide file tree
Showing 2 changed files with 109 additions and 0 deletions.
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: 🐛 Bug
description: Report an issue to help improve the project.
title: "[BUG] <description>"
labels: ["bug"]
body:
- type: checkboxes
id: duplicates
attributes:
label: Has this bug been raised before?
description: Increase the chances of your issue being accepted by making sure it has not been raised before.
options:
- label: I have checked "open" AND "closed" issues and this is not a duplicate
required: true
- type: textarea
id: description
attributes:
label: Description
description: A clear description of the bug you have found. Please include relevant information and resources (for example the steps to reproduce the bug)
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: To help us recreate the bug, provide a numbered list of the exact steps taken to trigger the buggy behavior.
value: |
Include any relevant details like:
- What page you were on...
- What you were trying to do...
- What went wrong...
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Please add screenshots if applicable
validations:
required: false
- type: dropdown
id: assignee
attributes:
label: Do you want to work on this issue?
multiple: false
options:
- "No"
- "Yes"
default: 0
validations:
required: false
- type: textarea
id: extrainfo
attributes:
label: If "yes" to above, please explain how you would technically implement this
description: For example reference any existing code
validations:
required: false
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: 💡 General Feature Request
description: Have a new idea/feature? Let us know...
title: "[FEATURE] <description>"
labels: ["enhancement", "feature"]
body:
- type: checkboxes
id: duplicates
attributes:
label: Is this a unique feature?
description: Increase the chances of your issue being accepted by making sure it has not been raised before.
options:
- label: I have checked "open" AND "closed" issues and this is not a duplicate
required: true
- type: textarea
attributes:
label: Is your feature request related to a problem/unavailable functionality? Please describe.
description: A clear and concise description of what the problem is (for example "I'm always frustrated when [...]").
validations:
required: true
- type: textarea
id: description
attributes:
label: Proposed Solution
description: A clear description of the enhancement you propose. Please include relevant information and resources (for example another project's implementation of this feature).
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Please add screenshots of the before and/or after the proposed changes.
validations:
required: false
- type: dropdown
id: assignee
attributes:
label: Do you want to work on this issue?
multiple: false
options:
- "No"
- "Yes"
default: 0
validations:
required: false
- type: textarea
id: extrainfo
attributes:
label: If "yes" to above, please explain how you would technically implement this (issue will not be assigned if this is skipped)
description: For example reference any existing code or library
validations:
required: false

0 comments on commit 72a01fa

Please sign in to comment.