From adfd1b9c935fe6265d39bac1a8b9d163ea22d9ea Mon Sep 17 00:00:00 2001 From: Frantisek Hrbata Date: Mon, 24 Feb 2025 13:16:18 +0100 Subject: [PATCH] change: add an IDF diag entry to the issue template Signed-off-by: Frantisek Hrbata --- .../ISSUE_TEMPLATE/01_build_install_bug.yml | 20 +++++++++++++++++++ .github/ISSUE_TEMPLATE/02_runtime_bug.yml | 20 +++++++++++++++++++ 2 files changed, 40 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/01_build_install_bug.yml b/.github/ISSUE_TEMPLATE/01_build_install_bug.yml index 5814dced92..c398391049 100644 --- a/.github/ISSUE_TEMPLATE/01_build_install_bug.yml +++ b/.github/ISSUE_TEMPLATE/01_build_install_bug.yml @@ -95,6 +95,26 @@ body: render: plain validations: required: false + - type: textarea + id: diag + attributes: + label: Diagnostic report archive. + description: | + 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. + + In your project directory, execute the following command: + + Using `idf.py diag` + 1. idf.py diag + + Using `esp-idf-diag` + 1. pip install esp-idf-diag + 2. esp-idf-diag create + + Once the report is generated, the tool will guide you with the next steps. + placeholder: Please attach the diagnostic report zip file here. + validations: + required: false - type: textarea id: more-info attributes: diff --git a/.github/ISSUE_TEMPLATE/02_runtime_bug.yml b/.github/ISSUE_TEMPLATE/02_runtime_bug.yml index 7d8722fe28..f2d6236312 100644 --- a/.github/ISSUE_TEMPLATE/02_runtime_bug.yml +++ b/.github/ISSUE_TEMPLATE/02_runtime_bug.yml @@ -123,6 +123,26 @@ body: render: plain validations: required: false + - type: textarea + id: diag + attributes: + label: Diagnostic report archive. + description: | + 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. + + In your project directory, execute the following command: + + Using `idf.py diag` + 1. idf.py diag + + Using `esp-idf-diag` + 1. pip install esp-idf-diag + 2. esp-idf-diag create + + Once the report is generated, the tool will guide you with the next steps. + placeholder: Please attach the diagnostic report zip file here. + validations: + required: false - type: textarea id: more-info attributes: