From 7e72e12e4cabe0c5cf77a40f252ecf17258bdd4a Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Mon, 16 Dec 2019 15:08:41 +1100 Subject: [PATCH] github: Update to new issue templates - Add a separate template for feature requests - Add links to Programming Guide, Documentation pages, forum in config.yml --- .../ISSUE_TEMPLATE/bug_report.md | 34 +++++++++++++------ .github/ISSUE_TEMPLATE/config.yml | 16 +++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 26 ++++++++++++++ 3 files changed, 65 insertions(+), 11 deletions(-) rename docs/issue_template.md => .github/ISSUE_TEMPLATE/bug_report.md (64%) create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/docs/issue_template.md b/.github/ISSUE_TEMPLATE/bug_report.md similarity index 64% rename from docs/issue_template.md rename to .github/ISSUE_TEMPLATE/bug_report.md index 7bf65e7815..5370fb442a 100644 --- a/docs/issue_template.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,15 @@ +--- +name: Bug report +about: ESP-IDF crashes, produces incorrect output, or has incorrect behavior +title: '' +labels: 'Type: Bug' +assignees: '' + +--- + ----------------------------- Delete below ----------------------------- -If your issue is a general question, starts similar to "How do I..", or is related to 3rd party development kits/libs, please discuss this on our community forum at esp32.com instead. +**Reminder: If your issue is a general question, starts similar to "How do I..", or is related to 3rd party development kits/libs, please discuss this on our community forum at https://esp32.com instead.** INSTRUCTIONS ============ @@ -15,11 +24,13 @@ If the issue cannot be solved after the steps before, please follow these instru 1. Fill in all the fields under **Environment** marked with [ ] by picking the correct option for you in each case and deleting the others. 2. Describe your problem. -3. Include [debug logs on the monitor](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/idf-monitor.html#automatically-decoding-addresses) or the [coredump](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/core_dump.html). -4. Provide more items under **Other items if possible** can help us better locate your problem. -5. Use markup (buttons above) and the Preview tab to check what the issue will look like. +3. Include [debug logs from the "monitor" tool](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/idf-monitor.html#automatically-decoding-addresses), or [coredumps](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/core_dump.html). +4. Providing as much information as possible under **Other items if possible** will help us locate and fix the problem. +5. Use [Markdown](https://guides.github.com/features/mastering-markdown/) (see formatting buttons above) and the Preview tab to check what the issue will look like. 6. Delete these instructions from the above to the below marker lines before submitting this issue. +**IMPORTANT: If you do not follow these instructions and provide the necessary details, your issue may not be resolved.** + ----------------------------- Delete above ----------------------------- ## Environment @@ -27,12 +38,14 @@ If the issue cannot be solved after the steps before, please follow these instru - Development Kit: [ESP32-Wrover-Kit|ESP32-DevKitC|ESP32-PICO-Kit|ESP32-LyraT|ESP32-LyraTD-MSC|none] - Kit version (for WroverKit/PicoKit/DevKitC): [v1|v2|v3|v4] - Module or chip used: [ESP32-WROOM-32|ESP32-WROOM-32D|ESP32-WROOM-32U|ESP32-WROVER|ESP32-WROVER-I|ESP32-WROVER-B|ESP32-WROVER-IB|ESP32-SOLO-1|ESP32-PICO-D4|ESP32] -- IDF version (run ``git describe --tags`` to find it): +- IDF version (run ``git describe --tags`` to find it): // v3.2-dev-1148-g96cd3b75c -- Build System: [Make|CMake] +- Build System: [Make|CMake|idf.py] - Compiler version (run ``xtensa-esp32-elf-gcc --version`` to find it): // 1.22.0-80-g6c4433a - Operating System: [Windows|Linux|macOS] +- (Windows only) environment type: [MSYS2 mingw32|ESP Command Prompt|Plain Command Prompt|PowerShell]. +- Using an IDE?: [No|Yes (please give details)] - Power Supply: [USB|external 5V|external 3.3V|Battery] ## Problem Description @@ -43,12 +56,12 @@ If the issue cannot be solved after the steps before, please follow these instru ### Actual Behavior -### Steps to repropduce +### Steps to reproduce 1. step1 2. ... -// It helps if you attach a picture of your setup/wiring here. +// If possible, attach a picture of your setup/wiring here. ### Code to reproduce this issue @@ -59,7 +72,7 @@ If the issue cannot be solved after the steps before, please follow these instru void app_main() { - + } ``` @@ -76,5 +89,4 @@ Please copy the plain text here for us to search the error log. Or attach the co - [ ] sdkconfig file (attach the sdkconfig file from your project folder) - [ ] elf file in the ``build`` folder (**note this may contain all the code details and symbols of your project.**) -- [ ] coredump (This provides stacks of tasks.) - +- [ ] coredump (This provides stacks of tasks.) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..9b5ce609ed --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,16 @@ +blank_issues_enabled: false +contact_links: + - name: ESP-IDF Programming Guide + url: https://docs.espressif.com/projects/esp-idf/en/latest/ + about: Documentation for configuring and using ESP-IDF + - name: Espressif documentation page + url: https://www.espressif.com/en/support/download/documents + about: Hardware documentation (datasheets, Technical Reference Manual, etc) + - name: Forum + url: https://esp32.com + about: For questions about using ESP-IDF and/or ESP32 series chips. Please submit all questions starting "How do I..." here. + - name: Hardware-related services + url: https://www.espressif.com/en/products/hardware-services + about: Espressif service providing hardware design and certification support + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..89593b1a8f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,26 @@ +--- +name: Feature request +about: Suggest an idea for ESP-IDF +title: '' +labels: 'Type: Feature Request' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** + +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** + +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** + +A clear and concise description of any alternative solutions or features you've considered. + +Please give as many details as you can. Include suggestions for useful APIs or interfaces if relevant. + +**Additional context** + +Add any other context or screenshots about the feature request here.