-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Adding Issue and Feature template #5999
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.
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
Merged
me-no-dev
merged 11 commits into
espressif:master
from
VojtechBartoska:Update_templates
Dec 14, 2021
Merged
Changes from 6 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
2380cdb
Templates_update
VojtechBartoska 6daad57
Update_template_fixes
VojtechBartoska cd2263a
Pull_request_template_formatting
VojtechBartoska b3045b4
Pull_request_template_formatting
VojtechBartoska b8b2f3e
PR_template_formatting
VojtechBartoska 912d088
Merge branch 'Update_templates' of https://github.com/VojtechBartoska…
VojtechBartoska c4fb2d9
Rendering and typo fixes
VojtechBartoska 0b4ebff
Espessif boards added
VojtechBartoska b3a5033
Add Decoder link and Readme update
VojtechBartoska 5f60847
Link fix
VojtechBartoska f71e386
Rendering functions
VojtechBartoska File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
name: Feature request | ||
description: Suggest an idea for this project | ||
labels: ["Type: Feature request"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
* We welcome any ideas or feature requests! It is helpful if you can explain exactly why the feature would be useful. | ||
* 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. | ||
* If you would like to contribute, please read the [contributions guide](https://docs.espressif.com/projects/arduino-esp32/en/latest/contributing.html). | ||
- type: input | ||
id: Area | ||
attributes: | ||
label: Related area | ||
description: Please briefly explain the area of your Pull Request. | ||
placeholder: eg. Board support, specific Peripheral, BT, Wifi... | ||
validations: | ||
required: true | ||
- type: input | ||
id: HW | ||
attributes: | ||
label: Hardware specification | ||
description: Please provide if your proposal depends on specific Hardware. | ||
placeholder: eg. Support for Adafruit 32u4 Board... | ||
VojtechBartoska marked this conversation as resolved.
Show resolved
Hide resolved
|
||
validations: | ||
required: true | ||
- type: textarea | ||
id: problem-related | ||
attributes: | ||
label: Is your feature request related to a problem? | ||
description: Please provide a clear and concise description of what the problem is. Add relevant issue link. | ||
placeholder: ex. I'm facing the issue/missing function... | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: solution | ||
attributes: | ||
label: Describe the solution you'd like | ||
description: Please provide a clear and concise description of what you want to happen. | ||
placeholder: ex. When using this function... | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: alternatives | ||
attributes: | ||
label: Describe alternatives you've considered | ||
description: Please provide a clear and concise description of any alternative solutions or features you've considered. | ||
placeholder: ex. Choosing other approach wouldn't work, because... | ||
- type: textarea | ||
id: context | ||
attributes: | ||
label: Additional context | ||
description: Please add any other context or screenshots about the feature request here. | ||
placeholder: ex. This would work only when ... |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
name: Issue report | ||
description: Report any problem here | ||
labels: ["Status: Awaiting triage"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
* Before reporting a new issue please check and search in [List of existing issues](https://github.com/espressif/arduino-esp32/issues?q=is%3Aissue) | ||
* Please check [Online Documentation](https://docs.espressif.com/projects/arduino-esp32/en/latest/index.html) | ||
* Take a look on [Troubleshooting guide](https://docs.espressif.com/projects/arduino-esp32/en/latest/troubleshooting.html) | ||
* If still experiencing the issue, please provide as many details as possible below about your hardware, computer setup and code. | ||
- type: input | ||
id: Board | ||
attributes: | ||
label: Board | ||
description: On which Board does this issue occur? | ||
placeholder: eg. ESP32 Dev Module, ESP32-S2, LilyGo TTGO LoRa32... | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: devboard | ||
attributes: | ||
label: Device Description | ||
description: What development board or other hardware is the chip attached to? | ||
placeholder: ex. DevKitC, plain module on breadboard, etc. If your hardware is custom or unusual, please attach a photo. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: other-hw | ||
attributes: | ||
label: Hardware Configuration | ||
description: Is anything else attached to the development board? | ||
placeholder: ex. GPIO 18 & 19 are connected to I2C devices. | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: version | ||
attributes: | ||
label: Version | ||
description: What version of Arduino ESP32 are you running? If possible, consider updating to the latest version. | ||
options: | ||
- latest master | ||
- v2.0.1 | ||
- v2.0.0 | ||
- v1.0.6 | ||
- other | ||
validations: | ||
required: true | ||
- type: input | ||
id: IDE | ||
attributes: | ||
label: IDE Name | ||
description: What IDE are you using? | ||
placeholder: eg. Arduino IDE, PlatformIO, IDF component... | ||
validations: | ||
required: true | ||
- type: input | ||
id: os | ||
attributes: | ||
label: Operating System | ||
description: On which OS does this issue occur? | ||
placeholder: ex. macOS 12.1, Windows 10... | ||
validations: | ||
required: true | ||
- type: input | ||
id: Flash | ||
attributes: | ||
label: Flash frequency | ||
description: What flash frequency is used? | ||
placeholder: eg. 40Mhz | ||
validations: | ||
required: true | ||
- type: dropdown | ||
VojtechBartoska marked this conversation as resolved.
Show resolved
Hide resolved
|
||
id: PSRAM | ||
attributes: | ||
label: PSRAM enabled | ||
description: Is PSRAM enabled? | ||
options: | ||
- 'yes' | ||
- 'no' | ||
validations: | ||
required: true | ||
- type: input | ||
id: Upload | ||
attributes: | ||
label: Upload speed | ||
description: What upload speed is used? | ||
placeholder: eg. 115200 | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: Description | ||
attributes: | ||
label: Description | ||
description: Please describe your problem here and expected behaviour | ||
placeholder: ex. Can't connect/weird behaviour/wrong function/missing parameter.. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: sketch | ||
attributes: | ||
label: Sketch | ||
description: Please provide your sketch/code which was run | ||
placeholder: ex. related part of the code | ||
validations: | ||
required: true | ||
- type: textarea | ||
VojtechBartoska marked this conversation as resolved.
Show resolved
Hide resolved
|
||
id: Debug | ||
attributes: | ||
label: Debug Message | ||
description: Please provide a debug message or error message. | ||
placeholder: Enable Core debug level - Debug on tools menu of Arduino IDE, then put the serial output here | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: other-remarks | ||
attributes: | ||
label: Other Steps to Reproduce | ||
description: Is there any other information you can think of which will help us reproduce this problem? | ||
placeholder: ex. I also tried on other OS, HW...it works correctly on that setup. | ||
- type: textarea | ||
id: more-info | ||
attributes: | ||
label: More Information | ||
VojtechBartoska marked this conversation as resolved.
Show resolved
Hide resolved
|
||
description: Do you have any other information from investigating this? | ||
placeholder: Add any additional info. | ||
- type: checkboxes | ||
id: confirmation | ||
attributes: | ||
label: I have check existing issues, online documentation and the Troubleshooting Guide | ||
VojtechBartoska marked this conversation as resolved.
Show resolved
Hide resolved
|
||
description: You agree to check all the resources above before opening a new issue. | ||
options: | ||
- label: I confirm I have check existing issues, online documentation and Troubleshooting guide. | ||
VojtechBartoska marked this conversation as resolved.
Show resolved
Hide resolved
|
||
required: true |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Arduino ESP32 Gitter Channel | ||
url: https://gitter.im/espressif/arduino-esp32 | ||
about: Community channel for questions and help | ||
- name: ESP32 Forum - Arduino | ||
url: https://esp32.com/viewforum.php?f=19 | ||
about: Official Forum for questions |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,18 @@ | ||
---------------------------------------------------------------------------------------------------------------------------------------------------- | ||
This entire section can be deleted if all items are checked. | ||
|
||
*By completing this PR sufficiently, you help us to improve the quality of Release Notes* | ||
|
||
### Checklist | ||
|
||
1. [ ] Please provide specific title of the PR describing the change, including the component name (eg."Update of Documentation link on Readme.md") | ||
1. [ ] Please provide specific title of the PR describing the change, including the component name (eg. *„Update of Documentation link on Readme.md“*) | ||
2. [ ] Please provide related links (eg. Issue, other Project, submodule PR..) | ||
---------------------------------------------------------------------------------------------------------------------------------------------------- | ||
3. [ ] Please check [Contributing guide](https://docs.espressif.com/projects/arduino-esp32/en/latest/contributing.html) | ||
|
||
*This entire section above can be deleted if all items are checked.* | ||
|
||
----------- | ||
## Summary | ||
Please describe your proposed PR and what it contains. | ||
|
||
## Impact | ||
Please describe impact of your PR and it's function. | ||
|
||
## Related links | ||
Please provide links to related issue, PRs etc. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.