Skip to content

Commit

Permalink
feat: add GitHub Issue templates
Browse files Browse the repository at this point in the history
Added templates for GitHub Issues to streamline bug reporting and
feature requests. The 'Report Bug' template includes fields for
description of the bug, expected behavior, actual behavior, affected
browsers, operating systems, steps to reproduce, and a checklist. The
'Feature Request' template includes fields for feature description,
use cases, and a checklist for issue submission.
  • Loading branch information
chessurisme committed May 8, 2024
1 parent 2bca0c2 commit abf20f3
Show file tree
Hide file tree
Showing 2 changed files with 109 additions and 0 deletions.
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
name: Report Bug
description: Help us improve by reporting a bug
labels: ['🐛 bug']
body:
- type: textarea
id: description
attributes:
label: 📝 Description,
description: A clear and concise description of the bug.
validations:
required: true
- type: textarea
id: expected
attributes:
label: 🎯 Expected Behavior,
description: A clear and concise description of what you expected to happen.
placeholder: e.g. It should export a JSON file when clicking the button.
validations:
required: true
- type: textarea
id: actual
attributes:
label: 🚫 Actual Behavior,
description: A clear and concise description of what actually happened.
placeholder: e.g. It just does not work when clicked.
validations:
required: true
- type: checkboxes
id: browsers
attributes:
label: Browser,
description: In which browser(s) are you experiencing the issue? You may select more than one.
options:
- label: Chrome/Chromium,
- label: Firefox,
- label: Safari,
- label: Edge,
- label: Opera,
- label: Kiwi,
- label: SPIN,
- label: Brave,
- label: Other/not relevant
validations:
required: true
- type: checkboxes
id: operating-systems
attributes:
label: Operating system,
description: In which operating systems are you experiencing the issue? You may select more than one.
options:
- label: Windows,
- label: Linux,
- label: macOS,
- label: iOS,
- label: Android,
- label: Other/not relevant
validations:
required: true
- type: textarea
id: stepsToReproduce
attributes:
label: Steps to reproduce,
description: Please provide a detailed guide on how this issue can be reproduced.
placeholder: |
1. I opened the modal by clicking the more button.
2. I clicked on the export JSON button.
...
validations:
required: true
- type: checkboxes
id: checklist
attributes:
label: ✅ Checklist,
description: Please review the following checklist before submitting your issue.
options:
- label: I have searched if someone has submitted a similar issue before and there weren't any. (Please make sure to also search closed issues, as this issue might already have been resolved.)
required: true
validations:
required: true
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/02-feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Feature Request
description: Share with us your ideas on how Quiz Manager could be improved upon.
labels: ['✨ enhancement']
body:
- type: textarea
id: description
attributes:
label: Description,
description: Try to describe in detail the feature you wish existed.
placeholder: e.g. I want to be able to lock certain quizzes while editing.
validations:
required: true
- type: textarea
id: use-cases
attributes:
label: Use cases,
description: Why do you need this feature? Provide real-life use cases as to why this feature will be useful for others.
placeholder: e.g. Sometimes, I accidentally edit a quiz that is not intended for editing.
validations:
required: true
- type: checkboxes
id: checklist
attributes:
label: Checklist,
description: Please check the following items before submitting your issue.
options:
- label: I have searched the existing issues to make sure this bug has not already been reported.
required: true
validations:
required: true

0 comments on commit abf20f3

Please sign in to comment.