OpenDTU-old/.github/ISSUE_TEMPLATE/bug_report.yml
2024-09-26 22:08:53 +02:00

106 lines
3.9 KiB
YAML

name: 🐛 Bug Report
description: File a bug report
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
### ⚠️ Please remember: issues are for *bugs*⚠️
That is, something you believe affects every single user of OpenDTU-OnBattery, not just you. If you're not sure, start with one of the other options below.
- type: markdown
attributes:
value: |
#### Have a question? 👉 [Start a new discussion](https://github.com/helgeerbe/OpenDTU-OnBattery/discussions/new/choose) or [ask in chat](https://discord.gg/WzhxEY62mB).
#### Before opening an issue, please double check:
- [Documentation](https://opendtu-onbattery.net)
- [The FAQs](https://opendtu-onbattery.net/firmware/faq/)
- [Existing issues and discussions](https://github.com/helgeerbe/OpenDTU-OnBattery/search?q=&type=issues)
- type: textarea
id: what-happened
attributes:
label: What happened?
description: A clear and concise description of what the bug is.
placeholder: Tell us what the problem is.
validations:
required: true
- type: textarea
id: how-to-reproduce
attributes:
label: To Reproduce Bug
description: Steps to reproduce the behavior, if consistently possible.
placeholder: Tell us how to make the bug appear.
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: Tell us what you expected to happen.
validations:
required: true
- type: dropdown
id: install_format
attributes:
label: Install Method
description: How did you install OpenDTU-OnBattery?
options:
- Pre-Compiled binary from GitHub releases
- Pre-Compiled binary from GitHub actions/pull-request
- Self-Compiled
validations:
required: true
- type: input
id: version
attributes:
label: What git-hash/version of OpenDTU-OnBattery?
description: You can find this in the Web UI at Info -> System.
placeholder: "e.g. 359d513"
validations:
required: true
- type: dropdown
id: environment
attributes:
label: What firmware variant (PIO Environment)?
description: You can find this in the Web UI at Info -> System.
options:
- "generic_esp32s3_usb"
- "generic_esp32s3"
- "generic_esp32_8mb"
- "generic_esp32_4mb_no_ota"
- "generic_esp32"
- "generic"
- "opendtufusionv2"
- "other (tell us in 'Anything else?')"
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log/trace output
description: Please copy and paste any relevant log output if you have it. This will be automatically formatted into code, so no need for backticks.
render: Shell
- 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
- type: checkboxes
id: required-checks
attributes:
label: Please confirm the following
options:
- label: I believe this issue is a bug that affects all users of OpenDTU-OnBattery, not something specific to my installation.
required: true
- label: I have already searched for relevant existing issues and discussions before opening this report.
required: true
- label: I have updated the title field above with a concise description.
required: true
- label: I have double checked that my inverter does not contain a W in the model name (like HMS-xxxW) as they are not supported.
required: true