Skip to content

Commit

Permalink
Create bug_report.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
vanvianen committed Aug 28, 2024
1 parent 990cca6 commit 67d169f
Showing 1 changed file with 217 additions and 0 deletions.
217 changes: 217 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@

---

# =============================================================================
# Header
# =============================================================================

name: Bug Report
description: File a bug report to help us improve.
title: "[BUG]: "
labels: ["Bug", "Needs Triage"]
assignees: []


# =============================================================================
# Body
# =============================================================================

body:

# Introduction
# =============================================================================

-
type: markdown
attributes:
value: |
## Bug Report
Thank you for taking the time to report a bug! We highly value all bug reports and strive to address them.
We appreciate your effort in highlighting a potential bug! To expedite our response and ensure clarity:
- Please furnish comprehensive details about the bug, focusing specifically on the features of this repository.
- Kindly remember, this repository is managed by dedicated volunteers. We ask for your understanding and patience.
- For clarity and ease of tracking, if you have multiple queries, suggestions, or issues, kindly create separate submissions for each.
- Familiar with a solution? We're open to pull requests. Feel free to contribute!
# Details
# =============================================================================

-
type: markdown
attributes:
value: |
### Details
-
type: checkboxes
id: issue-exists
attributes:
label: Existing Issues
description: |
Is there an existing issue for this?
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: input
id: feature
validations:
required: true
attributes:
label: Sample
description: |
Which feature are you having troubles with?
Use the feature name or URL. We don't want to be spend all this time diagnosing issues about the wrong feature, do we?
# Behavior
# =============================================================================

-
type: markdown
attributes:
value: |
### Behavior
-
type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: |
How do you reproduce this? Please provide as much step-by-step detail as possible.
placeholder: |
1. In this environment...
1. With this config...
1. Run '...'
1. See error...
validations:
required: true

-
type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: |
A clear and concise description of what you expected to happen.
placeholder: |
When I do '...', I expect '...'
validations:
required: true

-
type: textarea
id: actual-behavior
attributes:
label: Actual behavior
description: |
A clear and concise description of what actually happens.
placeholder: |
When I do '...', what actually happens is '...'
validations:
required: true

-
type: dropdown
id: frequency
attributes:
label: How often does the issue occur?
description: |
How frequently do you encounter this issue?
options:
- Every time
- Occasionally
- Rarely
- Just once
validations:
required: false


# Environment
# =============================================================================

-
type: markdown
attributes:
value: |
### Environment
Add relevant information about the environment in which this issue occurs.
-
type: input
id: operating-system
attributes:
label: Operating System
description: |
What operating system are you using?
placeholder: |
e.g. Windows 10, macOS Big Sur
validations:
required: false

-
type: input
id: software-version
attributes:
label: Software Version
description: |
What version of the software are you using?
placeholder: |
e.g. 1.0.0
validations:
required: false

-
type: input
id: hardware-specs
attributes:
label: Hardware Specifications
description: |
Please mention any relevant hardware details, such as CPU, GPU, RAM, etc.
placeholder: |
e.g. Intel i5, 8GB RAM, Nvidia GTX 1060
validations:
required: false


# Additional
# =============================================================================

-
type: markdown
attributes:
value: |
### Additional
-
type: textarea
id: additional-context
attributes:
label: Additional context
description: |
Add any other context, screenshots, or relevant information about the bug here.
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
placeholder: |
"Add context here"
validations:
required: false

-
type: textarea
id: logs
attributes:
label: Logs or Error Messages
description: |
If possible, include any logs or error messages related to the bug.
placeholder: |
"Paste the logs or error messages here"
validations:
required: false

0 comments on commit 67d169f

Please sign in to comment.