Skip to content

Commit 44ae1d0

Browse files
authored
Update issue templates with new diagnostics text (#4139)
* Update bug report template with new diagnostics text, put diagnostics above signature * Update device support request template with new diagnostics text, put diagnostics above signature
1 parent 6bc6247 commit 44ae1d0

File tree

2 files changed

+24
-36
lines changed

2 files changed

+24
-36
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,23 @@ body:
5555
attributes:
5656
value: |
5757
# Debug information
58+
- type: textarea
59+
attributes:
60+
label: Diagnostics information
61+
placeholder: "Drag-and-drop the diagnostics file here. Do not copy-paste the content."
62+
description: >-
63+
Diagnostics information is crucial for debugging issues with ZHA devices.
64+
65+
You can find the diagnostics information by going to the device page, clicking the three dots, and then by clicking on "Download diagnostics".
66+
Drag-and-drop the downloaded file into the textbox below.
5867
- type: textarea
5968
attributes:
6069
label: Device signature
6170
description: |
62-
You can find the device signature by going to the device page, clicking the three dots, clicking on "Manage Zigbee device", and then selecting the "Signature" tab at the top.
71+
Additionally providing the device signature allows us to quickly get an overview of the device clusters and see if a quirk is already applied to the device.
72+
It's optional to provide, since this information is already available in the diagnostics file, but it can help us to quickly identify issues.
6373
74+
You can find the device signature by going to the device page, clicking the three dots, clicking on "Manage Zigbee device", and then selecting the "Signature" tab at the top.
6475
Copy the contents and paste your device signature in between the lines with the backticks below.
6576
value: |
6677
<details><summary>Device signature</summary>
@@ -73,23 +84,6 @@ body:
7384
7485
</details>
7586
- type: textarea
76-
attributes:
77-
label: Diagnostic information
78-
description: |
79-
You can find the diagnostic information of the device by going to the device page, clicking the three dots, and then by clicking on "Download diagnostics".
80-
81-
Copy the contents of the downloaded text file and paste it in between the lines with the backticks below.
82-
value: |
83-
<details><summary>Diagnostic information</summary>
84-
85-
```json
86-
87-
[Paste the diagnostic information here]
88-
89-
```
90-
91-
</details>
92-
- type: textarea
9387
attributes:
9488
label: Logs
9589
description: |

.github/ISSUE_TEMPLATE/device_support_request.yml

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,23 @@ body:
4444
attributes:
4545
value: |
4646
# Debug information
47+
- type: textarea
48+
attributes:
49+
label: Diagnostics information
50+
placeholder: "Drag-and-drop the diagnostics file here. Do not copy-paste the content."
51+
description: >-
52+
Diagnostics information is crucial for debugging issues with ZHA devices.
53+
54+
You can find the diagnostics information by going to the device page, clicking the three dots, and then by clicking on "Download diagnostics".
55+
Drag-and-drop the downloaded file into the textbox below.
4756
- type: textarea
4857
attributes:
4958
label: Device signature
5059
description: |
51-
You can find the device signature by going to the device page, clicking the three dots, clicking on "Manage Zigbee device", and then selecting the "Signature" tab at the top.
60+
Additionally providing the device signature allows us to quickly get an overview of the device clusters and see if a quirk is already applied to the device.
61+
It's optional to provide, since this information is already available in the diagnostics file, but it can help us to quickly identify issues.
5262
63+
You can find the device signature by going to the device page, clicking the three dots, clicking on "Manage Zigbee device", and then selecting the "Signature" tab at the top.
5364
Copy the contents and paste your device signature in between the lines with the backticks below.
5465
value: |
5566
<details><summary>Device signature</summary>
@@ -62,23 +73,6 @@ body:
6273
6374
</details>
6475
- type: textarea
65-
attributes:
66-
label: Diagnostic information
67-
description: |
68-
You can find the diagnostic information of the device by going to the device page, clicking the three dots, and then by clicking on "Download diagnostics".
69-
70-
Copy the contents of the downloaded text file and paste it in between the lines with the backticks below.
71-
value: |
72-
<details><summary>Diagnostic information</summary>
73-
74-
```json
75-
76-
[Paste the diagnostic information here]
77-
78-
```
79-
80-
</details>
81-
- type: textarea
8276
attributes:
8377
label: Logs
8478
description: |

0 commit comments

Comments
 (0)