Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update ISSUE_TEMPLATE.md #4474

Merged
merged 4 commits into from
Mar 7, 2018
Merged

Update ISSUE_TEMPLATE.md #4474

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a035dbf
Update ISSUE_TEMPLATE.md
devyte Mar 7, 2018
14400d8
Update ISSUE_TEMPLATE.md
devyte Mar 7, 2018
046fcfd
Update ISSUE_TEMPLATE.md
devyte Mar 7, 2018
efd9302
Merge branch 'master' into devyte-issue_template
devyte Mar 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 46 additions & 19 deletions ISSUE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,36 +1,62 @@
----------------------------- Delete below -----------------------------
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy to approve as-is, as I think it presents the state of affairs for people who actually read it, but maybe right at the top you could add something like the below to direct people to the proper spot for 50% of the silly issues that are opened? I should have thought of it on my first comment....

Have a general question?
Don't know how to do something?
Trouble with a third-party library?
Please go to https://www.esp8266.com for the support forum to get answers!

Only continue with this issue report if you have a failure or bug with the current core libraries (i.e. crashes, hangs, etc.)


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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about using a readthedocs link here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, same for the stack dump.


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 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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That might be a bit harsh, no? I think it's fair that we also accept issue reports for release versions and ask to test with latest git if needed. How about "I have searched the issue tracker for a similar issue" instead?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Normally I'd agree, but our release model is linear wrt to development, i.e.: our releases are a snapshot of master, and we don't use branches for released versions (the typical "stable release" model). As a result, It doesn't make much sense to track issues that apply to a particular release, except maybe the very last release, because there are no release branches to port a fix to.
Whatever else, the current reality is that we're getting a whole lot of duplicate issues. A release has an issue, we get a report, we fix it in master, then we keep getting multiple reports for the same issue, and we can't always tell that all those additional issues are the same one. Then, when an issue comes up that isn't obvious, the first thing we do is ask to test with latest git anyways. This wastes a whole lot of time, both on our end because of dealing with those issues, and on the user's end because of the turnaround and turnaround back again.

My thinking is that installing git is easy enough, and it's even documented. The user is supposed to do his homework, but many are a bit lazy, or just don't know, so don't do enough research prior to opening an issue. So anything we can do to "encourage" a user to do due diligence, that reduces our own overhead, is good from my pov.
So I think your idea to search the issue tracker is a good one, but as an additional item.

- [ ] If there is a stack dump, I have decoded it.
- [ ] I have filled out all fields below.

### Description
#### Platform

Problem description
- 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]

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we please add LWIP version as well?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Errr...maybe this belongs in the next section, not here, but we still need LWIP.

### 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 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)


### Sketch
### Problem Description

Detailed problem description goes here.


### MCVE Sketch
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's make MCVE a link to https://stackoverflow.com/help/mcve

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, I thought I had put the link somewhere already.


```cpp

Expand All @@ -43,12 +69,13 @@ void setup() {
void loop() {

}

```

### Debug Messages

```
messages here
Debug messages go here
```