Skip to content

Commit 5b87c7b

Browse files
authored
Update ISSUE_TEMPLATE.md (#4474)
* Update ISSUE_TEMPLATE.md Proposal for issue template update * Update ISSUE_TEMPLATE.md Updates per feedback. * Update ISSUE_TEMPLATE.md Update based on feedback.
1 parent e47a92a commit 5b87c7b

File tree

1 file changed

+50
-20
lines changed

1 file changed

+50
-20
lines changed

ISSUE_TEMPLATE.md

+50-20
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,65 @@
1+
----------------------------- Delete below -----------------------------
12

2-
Please fill the info fields, it helps to get you faster support ;)
3+
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.
34

4-
if you have a stack dump decode it:
5-
https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/stack_dump.rst
5+
INSTRUCTIONS
6+
============
7+
If you do not follow these instructions, your issue may be dismissed.
68

7-
for better debug messages:
8-
https://github.com/esp8266/Arduino/blob/master/doc/Troubleshooting/debugging.rst
9+
1. Follow the checklist under Basic Infos and fill in the [ ] spaces with an X.
10+
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).
11+
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.
12+
4. Describe your problem.
13+
5. If you have a STACK DUMP decode it:
914

10-
----------------------------- Remove above -----------------------------
15+
https://arduino-esp8266.readthedocs.io/en/latest/Troubleshooting/stack_dump.html
16+
17+
6. Include a Minimal Complete Reproducible Example sketch that shows your issue. Do not include your entire project, or a huge piece of code.
18+
7. Include debug messages:
19+
20+
https://arduino-esp8266.readthedocs.io/en/latest/Troubleshooting/debugging.html
21+
22+
8. Use markup (buttons above) and the Preview tab to check what the issue will look like.
23+
9. Delete these instructions from the above to the below marker lines before submitting this issue.
24+
25+
26+
----------------------------- Delete above -----------------------------
1127

1228
### Basic Infos
1329

14-
#### Hardware
15-
Hardware: ?ESP-12?
16-
Core Version: ?2.1.0-rc2?
30+
- [ ] This issue complies with the [issue POLICY doc](https://github.com/esp8266/Arduino/blob/master/POLICY.md).
31+
- [ ] I have read the documentation at [readthedocs](https://arduino-esp8266.readthedocs.io/en/latest) and the issue is not addressed there.
32+
- [ ] I have tested that the issue is present in current master branch (aka latest git).
33+
- [ ] I have searched the issue tracker for a similar issue.
34+
- [ ] If there is a stack dump, I have decoded it.
35+
- [ ] I have filled out all fields below.
1736

18-
### Description
37+
#### Platform
1938

20-
Problem description
39+
- Hardware: [ESP-12|ESP-01|ESP-07|ESP8285 device|other]
40+
- Core Version: [latest git hash or date]
41+
- Development Env: [Arduino IDE|Platformio|Make|other]
42+
- Operating System: [Windows|Ubuntu|MacOS]
2143

2244
### Settings in IDE
2345

24-
Module: ?Generic ESP8266 Module?
25-
Flash Size: ?4MB/1MB?
26-
CPU Frequency: ?80Mhz?
27-
Flash Mode: ?qio?
28-
Flash Frequency: ?40Mhz?
29-
Upload Using: ?OTA / SERIAL?
30-
Reset Method: ?ck / nodemcu?
46+
- Module: [Generic ESP8266 Module|Wemos D1 mini r2|Nodemcu|other]
47+
- Flash Mode: [qio|dio|other]
48+
- Flash Size: [4MB/1MB]
49+
- lwip Variant: [v1.4|v2 Lower Memory|Higher Bandwidth]
50+
- Reset Method: [ck|nodemcu]
51+
- Flash Frequency: [40Mhz]
52+
- CPU Frequency: [80Mhz|160MHz]
53+
- Upload Using: [OTA|SERIAL]
54+
- Upload Speed: [115200|other] (serial upload only)
3155

3256

33-
### Sketch
57+
### Problem Description
58+
59+
Detailed problem description goes here.
60+
61+
62+
### [MCVE](https://stackoverflow.com/help/mcve) Sketch
3463

3564
```cpp
3665

@@ -43,12 +72,13 @@ void setup() {
4372
void loop() {
4473

4574
}
75+
4676
```
4777

4878
### Debug Messages
4979

5080
```
51-
messages here
81+
Debug messages go here
5282
```
5383

5484

0 commit comments

Comments
 (0)