Skip to content

Commit 71e4d9e

Browse files
committed
Merge branch 'change/issue_template_diag' into 'master'
change: add an IDF diag entry to the issue template Closes IDF-11826 See merge request espressif/esp-idf!37244
2 parents 14b9676 + adfd1b9 commit 71e4d9e

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

.github/ISSUE_TEMPLATE/01_build_install_bug.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,26 @@ body:
9595
render: plain
9696
validations:
9797
required: false
98+
- type: textarea
99+
id: diag
100+
attributes:
101+
label: Diagnostic report archive.
102+
description: |
103+
Diagnostic report for ESP-IDF created using [idf.py diag](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-diag.html) or [esp-idf-diag](https://github.com/espressif/esp-idf-diag). The `idf.py diag` command is available beginning with ESP-IDF version 5.5. For older versions, you may want to consider using the `esp-idf-diag` command.
104+
105+
In your project directory, execute the following command:
106+
107+
Using `idf.py diag`
108+
1. idf.py diag
109+
110+
Using `esp-idf-diag`
111+
1. pip install esp-idf-diag
112+
2. esp-idf-diag create
113+
114+
Once the report is generated, the tool will guide you with the next steps.
115+
placeholder: Please attach the diagnostic report zip file here.
116+
validations:
117+
required: false
98118
- type: textarea
99119
id: more-info
100120
attributes:

.github/ISSUE_TEMPLATE/02_runtime_bug.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,26 @@ body:
123123
render: plain
124124
validations:
125125
required: false
126+
- type: textarea
127+
id: diag
128+
attributes:
129+
label: Diagnostic report archive.
130+
description: |
131+
Diagnostic report for ESP-IDF created using [idf.py diag](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-diag.html) or [esp-idf-diag](https://github.com/espressif/esp-idf-diag). The `idf.py diag` command is available beginning with ESP-IDF version 5.5. For older versions, you may want to consider using the `esp-idf-diag` command.
132+
133+
In your project directory, execute the following command:
134+
135+
Using `idf.py diag`
136+
1. idf.py diag
137+
138+
Using `esp-idf-diag`
139+
1. pip install esp-idf-diag
140+
2. esp-idf-diag create
141+
142+
Once the report is generated, the tool will guide you with the next steps.
143+
placeholder: Please attach the diagnostic report zip file here.
144+
validations:
145+
required: false
126146
- type: textarea
127147
id: more-info
128148
attributes:

0 commit comments

Comments
 (0)