mirror of
https://github.com/MidnightBlueLabs/tetra-bluestation.git
synced 2026-03-29 05:09:51 +00:00
Update bug report templates
This commit is contained in:
committed by
Wouter Bokslag
parent
c02e165345
commit
8c2a9e2781
203
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
203
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,203 @@
|
||||
name: Bug report
|
||||
description: Report a bug to help improve tetra-bluestation
|
||||
title: "[BUG] "
|
||||
labels: ["bug"]
|
||||
assignees: []
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## 🐛 Bug Report
|
||||
|
||||
Thank you for reporting a bug.
|
||||
Please fill out **all required fields** so we can reproduce and fix the issue efficiently.
|
||||
|
||||
# -------------------------------------------------
|
||||
# Bug description
|
||||
# -------------------------------------------------
|
||||
- type: textarea
|
||||
id: bug_description
|
||||
attributes:
|
||||
label: Bug description
|
||||
description: Clear and concise description of what the bug is.
|
||||
placeholder: What happened?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
# -------------------------------------------------
|
||||
# Environment
|
||||
# -------------------------------------------------
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## Environment
|
||||
|
||||
- type: dropdown
|
||||
id: operating_system
|
||||
attributes:
|
||||
label: Operating system
|
||||
options:
|
||||
- Linux
|
||||
- macOS
|
||||
- Windows
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: os_version
|
||||
attributes:
|
||||
label: OS version
|
||||
placeholder: e.g. Ubuntu 22.04, macOS 14.2
|
||||
validations:
|
||||
required: false
|
||||
|
||||
# -------------------------------------------------
|
||||
# Hardware
|
||||
# -------------------------------------------------
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## Hardware
|
||||
|
||||
- type: dropdown
|
||||
id: sdr_model
|
||||
attributes:
|
||||
label: SDR model
|
||||
options:
|
||||
- LimeSDR
|
||||
- USRP
|
||||
- SXCeiver
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: radio_model
|
||||
attributes:
|
||||
label: Radio model
|
||||
placeholder: e.g. Motorola MXP600, custom board, N/A
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: host_hardware
|
||||
attributes:
|
||||
label: Host hardware
|
||||
description: Machine running `tetra-bluestation`
|
||||
placeholder: |
|
||||
- CPU:
|
||||
- RAM:
|
||||
- Architecture (x86_64 / ARM):
|
||||
validations:
|
||||
required: true
|
||||
|
||||
# -------------------------------------------------
|
||||
# Software / build info
|
||||
# -------------------------------------------------
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## Software / Build information
|
||||
|
||||
- type: dropdown
|
||||
id: git_branch
|
||||
attributes:
|
||||
label: Git branch
|
||||
description: Select the branch you used.
|
||||
options:
|
||||
- main
|
||||
- testing
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: git_branch_other
|
||||
attributes:
|
||||
label: Branch name (if "Other")
|
||||
description: |
|
||||
Fill this **only if you selected "Other" above**.
|
||||
placeholder: e.g. fix/bs-ul-mac
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: input
|
||||
id: commit_hash
|
||||
attributes:
|
||||
label: Commit hash
|
||||
placeholder: e.g. a1b2c3d (optional but recommended)
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: steps_to_reproduce
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: Exact steps to reproduce the bug.
|
||||
placeholder: |
|
||||
1. Build tetra-bluestation from <branch>
|
||||
2. Launch with your `config.toml` file
|
||||
3. Perform operation that creates bug
|
||||
4. Observe error
|
||||
validations:
|
||||
required: true
|
||||
|
||||
# -------------------------------------------------
|
||||
# Expected vs actual behavior
|
||||
# -------------------------------------------------
|
||||
- type: textarea
|
||||
id: expected_behavior
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
description: What did you expect to happen?
|
||||
placeholder: Describe the expected behavior.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: actual_behavior
|
||||
attributes:
|
||||
label: Actual behavior
|
||||
description: What actually happened?
|
||||
placeholder: Describe what actually occurred.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
# -------------------------------------------------
|
||||
# Logs / output
|
||||
# -------------------------------------------------
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
## Logs and outputs
|
||||
|
||||
- type: textarea
|
||||
id: command_output
|
||||
attributes:
|
||||
label: Command output
|
||||
description: |
|
||||
Paste the **exact console output** when the bug happens.
|
||||
Please avoid screenshots for logs.
|
||||
render: shell
|
||||
placeholder: |
|
||||
$ ./target/release/tetra-bluestation ./example_config/config.toml
|
||||
<full output here>
|
||||
validations:
|
||||
required: true
|
||||
|
||||
# -------------------------------------------------
|
||||
# Additional context
|
||||
# -------------------------------------------------
|
||||
- type: checkboxes
|
||||
id: confirmation
|
||||
attributes:
|
||||
label: Checklist
|
||||
options:
|
||||
- label: I have searched existing issues to avoid duplicates
|
||||
required: true
|
||||
- label: I am using a supported SDR device
|
||||
required: false
|
||||
- label: I can reproduce this issue reliably
|
||||
required: false
|
||||
Reference in New Issue
Block a user