Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 2463f57

Browse filesBrowse files
VojtechBartoskaVojtechBartoska
authored
Adding Issue and Feature template (espressif#5999)
Summary This PR contains adding: Issue template using forms Feature Template using forms Update of Pull Request template All yaml files have been checked by online validator. Pages are rendered here (for easier review): Feature Request template Issue Template Impact These templates can help with more accurate issue/PR explanations which can improve handling these contribution and in overall have a positive influence on User experience. Related links This PR closed issue espressif#5956
1 parent f29f448 commit 2463f57
Copy full SHA for 2463f57

File tree

Expand file treeCollapse file tree

6 files changed

+201
-61
lines changed
Filter options
Expand file treeCollapse file tree

6 files changed

+201
-61
lines changed

‎.github/ISSUE_TEMPLATE/Feature-request.yml

Copy file name to clipboard
+54Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
labels: ["Type: Feature request"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
* We welcome any ideas or feature requests! It is helpful if you can explain exactly why the feature would be useful.
9+
* There are usually some outstanding feature requests in the [existing issues list](https://github.com/espressif/arduino-esp32/issues?q=is%3Aopen+is%3Aissue+label%3A%22Type%3A+Feature+request%22), feel free to add comments to them.
10+
* If you would like to contribute, please read the [contributions guide](https://docs.espressif.com/projects/arduino-esp32/en/latest/contributing.html).
11+
- type: input
12+
id: Area
13+
attributes:
14+
label: Related area
15+
description: Please briefly explain the area of your Feature Request.
16+
placeholder: eg. Board support, specific Peripheral, BT, Wifi...
17+
validations:
18+
required: true
19+
- type: input
20+
id: HW
21+
attributes:
22+
label: Hardware specification
23+
description: Please provide if your proposal depends on specific Hardware.
24+
placeholder: eg. Support for ESP32 DevKitC, ESP32-C3 DevKitM...
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: problem-related
29+
attributes:
30+
label: Is your feature request related to a problem?
31+
description: Please provide a clear and concise description of what the problem is. Add relevant issue link.
32+
placeholder: ex. I'm facing the issue/missing function...
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: solution
37+
attributes:
38+
label: Describe the solution you'd like
39+
description: Please provide a clear and concise description of what you want to happen.
40+
placeholder: ex. When using this function...
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: alternatives
45+
attributes:
46+
label: Describe alternatives you've considered
47+
description: Please provide a clear and concise description of any alternative solutions or features you've considered.
48+
placeholder: ex. Choosing other approach wouldn't work, because...
49+
- type: textarea
50+
id: context
51+
attributes:
52+
label: Additional context
53+
description: Please add any other context or screenshots about the feature request here.
54+
placeholder: ex. This would work only when ...

‎.github/ISSUE_TEMPLATE/Issue-report.yml

Copy file name to clipboard
+130Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
name: Issue report
2+
description: Report any problem here
3+
labels: ["Status: Awaiting triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
* Before reporting a new issue please check and search in [List of existing issues](https://github.com/espressif/arduino-esp32/issues?q=is%3Aissue)
9+
* Please check [Online Documentation](https://docs.espressif.com/projects/arduino-esp32/en/latest/index.html)
10+
* Take a look on [Troubleshooting guide](https://docs.espressif.com/projects/arduino-esp32/en/latest/troubleshooting.html)
11+
* If still experiencing the issue, please provide as many details as possible below about your hardware, computer setup and code.
12+
- type: input
13+
id: Board
14+
attributes:
15+
label: Board
16+
description: On which Board does this issue occur?
17+
placeholder: eg. ESP32 Dev Module, ESP32-S2, LilyGo TTGO LoRa32...
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: devboard
22+
attributes:
23+
label: Device Description
24+
description: What development board or other hardware is the chip attached to?
25+
placeholder: ex. DevKitC, plain module on breadboard, etc. If your hardware is custom or unusual, please attach a photo.
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: other-hw
30+
attributes:
31+
label: Hardware Configuration
32+
description: Is anything else attached to the development board?
33+
placeholder: ex. GPIO 18 & 19 are connected to I2C devices.
34+
validations:
35+
required: true
36+
- type: dropdown
37+
id: version
38+
attributes:
39+
label: Version
40+
description: What version of Arduino ESP32 are you running? If possible, consider updating to the latest version.
41+
options:
42+
- latest master
43+
- v2.0.1
44+
- v2.0.0
45+
- v1.0.6
46+
- other
47+
validations:
48+
required: true
49+
- type: input
50+
id: IDE
51+
attributes:
52+
label: IDE Name
53+
description: What IDE are you using?
54+
placeholder: eg. Arduino IDE, PlatformIO, IDF component...
55+
validations:
56+
required: true
57+
- type: input
58+
id: os
59+
attributes:
60+
label: Operating System
61+
description: On which OS does this issue occur?
62+
placeholder: ex. macOS 12.1, Windows 10...
63+
validations:
64+
required: true
65+
- type: input
66+
id: Flash
67+
attributes:
68+
label: Flash frequency
69+
description: What flash frequency is used?
70+
placeholder: eg. 40Mhz
71+
validations:
72+
required: true
73+
- type: dropdown
74+
id: PSRAM
75+
attributes:
76+
label: PSRAM enabled
77+
description: Is PSRAM enabled?
78+
options:
79+
- 'yes'
80+
- 'no'
81+
validations:
82+
required: true
83+
- type: input
84+
id: Upload
85+
attributes:
86+
label: Upload speed
87+
description: What upload speed is used?
88+
placeholder: eg. 115200
89+
validations:
90+
required: true
91+
- type: textarea
92+
id: Description
93+
attributes:
94+
label: Description
95+
description: Please describe your problem here and expected behaviour
96+
placeholder: ex. Can't connect/weird behaviour/wrong function/missing parameter..
97+
validations:
98+
required: true
99+
- type: textarea
100+
id: sketch
101+
attributes:
102+
label: Sketch
103+
description: Please provide your sketch/code which was run
104+
placeholder: ex. related part of the code
105+
render: cpp
106+
validations:
107+
required: true
108+
- type: textarea
109+
id: Debug
110+
attributes:
111+
label: Debug Message
112+
description: Please provide a debug message or error message. If you have a Guru Meditation Error or Backtrace, please decode it with [ExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecoder)
113+
placeholder: Enable Core debug level - Debug on tools menu of Arduino IDE, then put the serial output here.
114+
render: plain
115+
validations:
116+
required: true
117+
- type: textarea
118+
id: other-remarks
119+
attributes:
120+
label: Other Steps to Reproduce
121+
description: Is there any other information you can think of which will help us reproduce this problem? Any additional info can be added as well.
122+
placeholder: ex. I also tried on other OS, HW...it works correctly on that setup.
123+
- type: checkboxes
124+
id: confirmation
125+
attributes:
126+
label: I have checked existing issues, online documentation and the Troubleshooting Guide
127+
description: You agree to check all the resources above before opening a new issue.
128+
options:
129+
- label: I confirm I have checked existing issues, online documentation and Troubleshooting guide.
130+
required: true

‎.github/ISSUE_TEMPLATE/bug_report.md

Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/bug_report.md
-54Lines changed: 0 additions & 54 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/config.yml

Copy file name to clipboard
+8Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Arduino ESP32 Gitter Channel
4+
url: https://gitter.im/espressif/arduino-esp32
5+
about: Community channel for questions and help
6+
- name: ESP32 Forum - Arduino
7+
url: https://esp32.com/viewforum.php?f=19
8+
about: Official Forum for questions

‎.github/PULL_REQUEST_TEMPLATE.md

Copy file name to clipboard
+8-6Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1-
----------------------------------------------------------------------------------------------------------------------------------------------------
2-
This entire section can be deleted if all items are checked.
3-
41
*By completing this PR sufficiently, you help us to improve the quality of Release Notes*
52

63
### Checklist
7-
8-
1. [ ] Please provide specific title of the PR describing the change, including the component name (eg."Update of Documentation link on Readme.md")
4+
1. [ ] Please provide specific title of the PR describing the change, including the component name (eg. *„Update of Documentation link on Readme.md“*)
95
2. [ ] Please provide related links (eg. Issue, other Project, submodule PR..)
10-
----------------------------------------------------------------------------------------------------------------------------------------------------
6+
3. [ ] Please check [Contributing guide](https://docs.espressif.com/projects/arduino-esp32/en/latest/contributing.html)
117

8+
*This entire section above can be deleted if all items are checked.*
9+
10+
-----------
1211
## Summary
1312
Please describe your proposed PR and what it contains.
1413

1514
## Impact
1615
Please describe impact of your PR and it's function.
16+
17+
## Related links
18+
Please provide links to related issue, PRs etc.

‎README.md

Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ You can use [EspExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecod
3838
### Issue/Bug report template
3939
Before reporting an issue, make sure you've searched for similar one that was already created. Also make sure to go through all the issues labelled as [Type: For reference](https://github.com/espressif/arduino-esp32/issues?q=is%3Aissue+label%3A%22Type%3A+For+reference%22+).
4040

41-
Finally, if you are sure no one else had the issue, follow the [issue template](docs/ISSUE_TEMPLATE.md) while reporting any issue.
41+
Finally, if you are sure no one else had the issue, follow the **Issue template** or **Feature request template** while reporting any [new Issue](https://github.com/espressif/arduino-esp32/issues/new/choose).
4242

4343
### Contributing
4444

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.