Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add Bug Report issue form template #44

Merged
merged 2 commits into from
Mar 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: πŸ› Bug Report
description: "Submit a bug report to help us improve"
title: "πŸ› Bug: "
labels: ["πŸ› bug"]
body:
- type: textarea
id: description
validations:
required: true
attributes:
label: "🐞 What is the bug you are experiencing?"
description: "Describe the bug clearly and concisely."
placeholder: "This feature breaks when ..."
- type: textarea
id: reproduction-steps
validations:
required: true
attributes:
label: "πŸͺœ What are the steps to reproduce this bug?"
description: "Walk us through the process, step-by-step, to trigger the bug."
placeholder: "1. Go to '...' 2. Click on '...' 3. Scroll to '...' 4. Error is shown"
- type: textarea
id: expected-behavior
validations:
required: true
attributes:
label: "βœ… What is the expected behavior?"
description: "If this bug does not occur, what do you think should happen?"
placeholder: "It should ..."
- type: textarea
id: actual-behavior
validations:
required: true
attributes:
label: "🚫 What is the actual behavior?"
description: "Describe what is actually happening. Add screenshots, if applicable."
placeholder: "It actually ..."
- type: textarea
id: additional-info
validations:
required: false
attributes:
label: "πŸ“ƒ Additional information"
description: "Add any extra information or contexts that may help us narrow down on the source of the bug."
placeholder: "Additionally, ..."
- type: checkboxes
id: no-duplicate-issues
attributes:
label: "πŸ” Have you checked to see if this bug has been reported before?"
options:
- label: "I checked and didn't find a similar report"
required: true