Skip to content

Commit

Permalink
docs: add issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
maddawik committed Oct 17, 2024
1 parent d4fc170 commit 6257851
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/1_BUG-FORM.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: 🐞 Bug
description: Report a bug/issue
title: "[BUG] <title>"
labels: [bug]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: What happened?
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
2. Run '...'
[What you expected]: Success
[What actually happened]: Error
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/2_FEATURE-REQUEST-FORM.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: 🏗️ Feature
description: Feature request
title: "[FEATURE] <title>"
labels: [improvement]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the feature request.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Issue / Request Related to a Problem?
description: A clear and concise description of what the problem is.
placeholder: ex. I'm always frustrated when [...].
validations:
required: false
- type: textarea
attributes:
label: Solution
description: Sequence of steps needed to complete this feature.
value: |
- [ ] Step 1
- [ ] Step 2
- [ ] Step 3
validations:
required: false
- type: textarea
attributes:
label: Additional Context
description: Add any other context or screenshots about the feature request here.
validations:
required: false

0 comments on commit 6257851

Please sign in to comment.