From a035dbf16d25204a9aa806b1417c692684c6e9a5 Mon Sep 17 00:00:00 2001 From: Develo Date: Tue, 6 Mar 2018 22:59:36 -0300 Subject: [PATCH 1/3] Update ISSUE_TEMPLATE.md Proposal for issue template update --- ISSUE_TEMPLATE.md | 63 +++++++++++++++++++++++++++++++++-------------- 1 file changed, 44 insertions(+), 19 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index a52d11faef..dcf905fd37 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,36 +1,60 @@ +----------------------------- Delete below ----------------------------- -Please fill the info fields, it helps to get you faster support ;) +INSTRUCTIONS +============ +If you do not follow these instructions, your issue may be dismissed. + +1. Follow the checklist and fill in the [ ] spaces with an X. +2. Fill in all the fields marked with [ ] (pick the correct option for you in each case, delete the others). +3. If you haven't already done so, test your issue against current master branch (aka latest git), because it may have been already fixed. +4. Describe your problem. +5. If you have a STACK DUMP decode it: -if you have a stack dump decode it: https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/stack_dump.rst -for better debug messages: -https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/debugging.rst +6. Include a Minimal Complete Reproducible Example sketch that shows your issue. Do not include your entire project, or a huge piece of code. +7. Include debug messages: + +https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/debugging.rst + +8. Use markup (buttons above) and the Preview tab to check what the issue will look like. +9. Delete these instructions from the above to the below marker lines before submitting this issue. + ------------------------------ Remove above ----------------------------- +----------------------------- Delete above ----------------------------- ### Basic Infos -#### Hardware -Hardware: ?ESP-12? -Core Version: ?2.1.0-rc2? +- [ ] This issue complies with the [issue POLICY doc](https://github.com/esp8266/Arduino/blob/master/POLICY.md). +- [ ] I have tested that the issue is present in current master branch (aka latest git). +- [ ] If there is a stack dump, I have decoded it. +- [ ] I have filled out all fields below. -### Description +#### Platform -Problem description +- Hardware: [ESP-12] +- Core Version: [latest git hash or date] +- Development Env: [Arduino IDE|Platformio|Make|other] +- Operating System: [Windows|Ubuntu|MacOS] ### Settings in IDE -Module: ?Generic ESP8266 Module? -Flash Size: ?4MB/1MB? -CPU Frequency: ?80Mhz? -Flash Mode: ?qio? -Flash Frequency: ?40Mhz? -Upload Using: ?OTA / SERIAL? -Reset Method: ?ck / nodemcu? +- Module: [Generic ESP8266 Module|Wemos D1 mini r2|Nodemcu|other] +- Flash Size: [4MB/1MB] +- CPU Frequency: [80Mhz|160MHz] +- Flash Mode: [qio|dio|other] +- Flash Frequency: [40Mhz] +- Upload Using: [OTA|SERIAL] +- Upload speed: [115200|other] (serial upload only) +- Reset Method: [ck|nodemcu] -### Sketch +### Problem Description + +Detailed problem description goes here. + + +### MCVE Sketch ```cpp @@ -43,12 +67,13 @@ void setup() { void loop() { } + ``` ### Debug Messages ``` -messages here +Debug messages go here ``` From 14400d81a6ef49cd3a7713009166f5deec74e498 Mon Sep 17 00:00:00 2001 From: Develo Date: Wed, 7 Mar 2018 00:34:12 -0300 Subject: [PATCH 2/3] Update ISSUE_TEMPLATE.md Updates per feedback. --- ISSUE_TEMPLATE.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index dcf905fd37..bef67db016 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -26,13 +26,14 @@ https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/debugging.rst ### Basic Infos - [ ] This issue complies with the [issue POLICY doc](https://github.com/esp8266/Arduino/blob/master/POLICY.md). +- [ ] I have read the documentation at [readthedocs](https://arduino-esp8266.readthedocs.io/en/latest) and the issue is not addressed there. - [ ] I have tested that the issue is present in current master branch (aka latest git). - [ ] If there is a stack dump, I have decoded it. - [ ] I have filled out all fields below. #### Platform -- Hardware: [ESP-12] +- Hardware: [ESP-12|ESP-01|ESP-07|ESP8285 device|other] - Core Version: [latest git hash or date] - Development Env: [Arduino IDE|Platformio|Make|other] - Operating System: [Windows|Ubuntu|MacOS] @@ -40,13 +41,14 @@ https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/debugging.rst ### Settings in IDE - Module: [Generic ESP8266 Module|Wemos D1 mini r2|Nodemcu|other] -- Flash Size: [4MB/1MB] -- CPU Frequency: [80Mhz|160MHz] - Flash Mode: [qio|dio|other] +- Flash Size: [4MB/1MB] +- lwip Variant: [v1.4|v2 Lower Memory|Higher Bandwidth] +- Reset Method: [ck|nodemcu] - Flash Frequency: [40Mhz] +- CPU Frequency: [80Mhz|160MHz] - Upload Using: [OTA|SERIAL] -- Upload speed: [115200|other] (serial upload only) -- Reset Method: [ck|nodemcu] +- Upload Speed: [115200|other] (serial upload only) ### Problem Description From 046fcfd48bfd4e1221bbdf13659d7c6acdee2226 Mon Sep 17 00:00:00 2001 From: Develo Date: Wed, 7 Mar 2018 14:12:15 -0300 Subject: [PATCH 3/3] Update ISSUE_TEMPLATE.md Update based on feedback. --- ISSUE_TEMPLATE.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index bef67db016..51d0688744 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,21 +1,23 @@ ----------------------------- Delete below ----------------------------- +If your issue is a general question, starts similar to "How do I..", is related to 3rd party libs, or is related to hardware, please discuss at a community forum like esp8266.com. + INSTRUCTIONS ============ If you do not follow these instructions, your issue may be dismissed. -1. Follow the checklist and fill in the [ ] spaces with an X. -2. Fill in all the fields marked with [ ] (pick the correct option for you in each case, delete the others). +1. Follow the checklist under Basic Infos and fill in the [ ] spaces with an X. +2. Fill in all the fields under Platform and Settings in IDE marked with [ ] (pick the correct option for you in each case, delete the others). 3. If you haven't already done so, test your issue against current master branch (aka latest git), because it may have been already fixed. 4. Describe your problem. 5. If you have a STACK DUMP decode it: -https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/stack_dump.rst +https://arduino-esp8266.readthedocs.io/en/latest/Troubleshooting/stack_dump.html 6. Include a Minimal Complete Reproducible Example sketch that shows your issue. Do not include your entire project, or a huge piece of code. 7. Include debug messages: -https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/debugging.rst +https://arduino-esp8266.readthedocs.io/en/latest/Troubleshooting/debugging.html 8. Use markup (buttons above) and the Preview tab to check what the issue will look like. 9. Delete these instructions from the above to the below marker lines before submitting this issue. @@ -28,6 +30,7 @@ https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/debugging.rst - [ ] This issue complies with the [issue POLICY doc](https://github.com/esp8266/Arduino/blob/master/POLICY.md). - [ ] I have read the documentation at [readthedocs](https://arduino-esp8266.readthedocs.io/en/latest) and the issue is not addressed there. - [ ] I have tested that the issue is present in current master branch (aka latest git). +- [ ] I have searched the issue tracker for a similar issue. - [ ] If there is a stack dump, I have decoded it. - [ ] I have filled out all fields below. @@ -56,7 +59,7 @@ https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/debugging.rst Detailed problem description goes here. -### MCVE Sketch +### [MCVE](https://stackoverflow.com/help/mcve) Sketch ```cpp