Skip to content

Commit 787cc71

Browse files
authored
Add issue template (#105)
1 parent 794cfc2 commit 787cc71

File tree

2 files changed

+73
-0
lines changed

2 files changed

+73
-0
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: ESPHome Wake Word Voice Assistants Bug Report
2+
description: |-
3+
Report an issue with the ESPHome Wake Word Voice Assistant firmware provided by this repository,
4+
the web installer and the provided OTA updates.
5+
If you have taken control of the device in the ESPHome Builder, please report the issue in the main ESPHome issue tracker.
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
This issue form is for reporting bugs with the ESPHome Wake Word Voice Assistant firmware that is compiled and released
11+
from this repository. This includes flashing the firmware from the ESPHome projects page and the OTA updates that are provided.
12+
13+
If you have taken control of the device in the ESPHome Builder, please report the issue in the main [ESPHome issue tracker][issues].
14+
15+
[issues]: https://github.com/esphome/issues
16+
17+
- type: textarea
18+
validations:
19+
required: true
20+
id: problem
21+
attributes:
22+
label: The problem
23+
description: >-
24+
Describe the issue you are experiencing here to communicate to the
25+
maintainers. Tell us what you were trying to do and what happened.
26+
27+
Provide a clear and concise description of what the problem is.
28+
29+
- type: dropdown
30+
validations:
31+
required: true
32+
id: device
33+
attributes:
34+
label: Which device are you using?
35+
options:
36+
- esp32-s3-box
37+
- esp32-s3-box-lite
38+
- esp32-s3-box-3
39+
- m5stack-atom-echo
40+
41+
- type: input
42+
id: version
43+
validations:
44+
required: true
45+
attributes:
46+
label: Firmware Version
47+
description: >
48+
The version of the installed version. This is **NOT** the ESPHome version, but is in the format `25.2.1` for example.
49+
50+
- type: textarea
51+
id: logs
52+
validations:
53+
required: true
54+
attributes:
55+
label: Logs
56+
description: Serial logs from the USB port are required
57+
render: txt
58+
59+
- type: textarea
60+
id: additional
61+
attributes:
62+
label: Additional information
63+
description: >
64+
If you have any additional information for us, use the field below.
65+
Please note, you can attach screenshots or screen recordings here, by
66+
dragging and dropping files in the field below.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Issue after taking control of the firmware provided here
4+
url: https://github.com/esphome/issues/issues
5+
about: |-
6+
Please search for or create an issue in the main ESPHome issue tracker
7+
if you have taken control/adpted your device in the ESPHome Builder.

0 commit comments

Comments
 (0)