forked from espressif/esp-bsp
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request espressif#311 from Indastri/master
Creating Issue templates (BSP-477)
- Loading branch information
Showing
4 changed files
with
142 additions
and
9 deletions.
There are no files selected for viewing
This file contains 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,61 @@ | ||
| 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/esp-bsp/issues?q=is%3Aopen+is%3Aissue+label%3A%22Type%3A+Feature+request%22), feel free to add comments to them. | ||
| - type: input | ||
| id: Area | ||
| attributes: | ||
| label: Related area | ||
| description: Please briefly explain the area of your Feature Request. | ||
| placeholder: eg. Component, BSP package, Driver, Display, peripheral, etc. | ||
| 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 ESP32 DevKitC, ESP32-C3 DevKitM... | ||
| 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 ... | ||
| - type: checkboxes | ||
| id: confirmation | ||
| attributes: | ||
| label: I have checked existing list of Feature requests and the Contribution Guide | ||
| description: You agree to check all the resources above before opening a new Feature request. | ||
| options: | ||
| - label: I confirm I have checked existing list of Feature requests and Contribution Guide. | ||
| required: true |
This file contains 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,73 @@ | ||
| 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/esp-bsp/issues?q=is%3Aissue) | ||
| * Please check [README.md](https://github.com/espressif/esp-bsp/blob/master/README.md) | ||
| * 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: Hardware Description | ||
| description: What display 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: input | ||
| id: IDE | ||
| attributes: | ||
| label: IDE Name | ||
| description: What IDE are you using? | ||
| placeholder: eg. VSCode, Espressif-IDE... | ||
| 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: 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 full minimal sketch/code which can be run to reproduce your issue | ||
| placeholder: ex. Related part of the code to replicate the issue | ||
| render: cpp | ||
| 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? Any additional info can be added as well. | ||
| placeholder: ex. I also tried on other OS, HW...it works correctly on that setup. | ||
| - type: checkboxes | ||
| id: confirmation | ||
| attributes: | ||
| label: I have checked existing issues, README.md and ESP32 Forum | ||
| description: You agree to check all the resources above before opening a new issue. [README.md](https://github.com/espressif/esp-bsp/blob/master/README.md), [ESP32 forum](https://www.esp32.com/) | ||
| options: | ||
| - label: I confirm I have checked existing issues, online documentation and Troubleshooting guide. | ||
| required: true |
This file contains 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: BSP Repository README | ||
| url: https://github.com/espressif/esp-bsp/blob/master/README.md | ||
| - name: ESP32 Forum | ||
| url: www.esp32.com | ||
| - name: Development Guide for BSP | ||
| url: https://github.com/espressif/esp-bsp/blob/master/BSP_development_guide.md |
This file was deleted.
Oops, something went wrong.