Skip to content

Commit fe4cf8e

Browse files
authored
better feature request template (#751)
* better feature request template * bug template improved
1 parent 5d43ddb commit fe4cf8e

File tree

2 files changed

+37
-26
lines changed

2 files changed

+37
-26
lines changed

.github/ISSUE_TEMPLATE/bug-report---problem.md

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,44 +8,51 @@ assignees: ''
88
---
99

1010
**Describe the bug**
11-
A clear and concise description of what the bug is.
11+
12+
<!--A clear and concise description of what the bug is.-->
1213

1314
**To Reproduce**
14-
Steps to reproduce the behavior:
15+
16+
<!--Steps to reproduce the behavior:-->
1517
1. Go to '...'
1618
2. Click on '....'
1719
3. Scroll down to '....'
1820
4. See error
1921

2022
**Expected behavior**
21-
A clear and concise description of what you expected to happen.
23+
24+
<!--A clear and concise description of what you expected to happen.-->
2225

2326
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
27+
28+
<!--If applicable, add screenshots to help explain your problem.-->
2529

2630
**ESP3D Firmware:**
27-
- ESP core version: [2.5.2]
28-
- Version:[e.g 2.1b4]
29-
- Web UI Version:[e.g 2.1b14]
30-
- Wifi mode:[e.g. STA]
31-
- Flash method: [Arduino Ide / PlatformIO]
32-
- Any change done in FW
33-
34-
tips: to get ESP3D informations type `[ESP420]plain`
35-
to get WebUI version check your menu header
3631

32+
<!-- tips:
33+
- to get ESP3D informations type `[ESP420]plain`
34+
- to get WebUI version check your menu header-->
35+
36+
- ESP core version: [e.g. 2.5.2]
37+
- Version:[e.g. 2.1b4]
38+
- Web UI Version:[e.g. 2.1b14]
39+
- Wifi mode:[e.g. STA/AP]
40+
- Flash method: [Arduino Ide / PlatformIO]
41+
- Any change done in FW:
3742

3843
**Target Firmware:**
39-
- Name: [e.g. Marlin]
40-
- Version [e.g. 2.0]
41-
42-
tip: to get firmware info type `M115` in console
44+
45+
<!-- tip: to get firmware info type `M115` in console -->
46+
- Name: [e.g. Marlin]
47+
- Version [e.g. 2.0]
4348

4449
**Board used (please complete the following information):**
45-
- MCU: [e.g. ESP32]
46-
- Name:[e.g. NodeMCU2s]
47-
- Flash size: [e.g. 4M: 2M/2M]
50+
51+
- MCU:[e.g. ESP32]
52+
- Name:[e.g. NodeMCU2s]
53+
- Flash size: [e.g. 4M: 2M/2M]
4854

4955
**Additional context**
50-
Add any other context about the problem here.
51-
Wiring, decoded stack, etc...
56+
57+
<!--Add any other context about the problem here.
58+
Wiring, decoded stack, etc...-->

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,17 @@ assignees: ''
88
---
99

1010
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
11+
12+
<!--A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]-->
1213

1314
**Describe the solution you'd like**
14-
A clear and concise description of what you want to happen.
15+
16+
<!--A clear and concise description of what you want to happen.-->
1517

1618
**Describe alternatives you've considered**
17-
A clear and concise description of any alternative solutions or features you've considered.
19+
20+
<!--A clear and concise description of any alternative solutions or features you've considered.-->
1821

1922
**Additional context**
20-
Add any other context or screenshots about the feature request here.
23+
24+
<!--Add any other context or screenshots about the feature request here.-->

0 commit comments

Comments
 (0)