forked from hathach/tinyusb
-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
change(tinyusb): Added repo templates for issue and pull request
- Loading branch information
Showing
5 changed files
with
48 additions
and
131 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 |
---|---|---|
@@ -1,86 +1,48 @@ | ||
name: Bug Report | ||
description: Report a problem with TinyUSB | ||
labels: 'Bug 🐞' | ||
name: Bug report | ||
description: Report build and runtime bugs | ||
labels: ["Type: Bug"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! | ||
It's okay to leave some blank if it doesn't apply to your problem. | ||
- type: dropdown | ||
- type: checkboxes | ||
id: checklist | ||
attributes: | ||
label: Operating System | ||
label: Answers checklist. | ||
description: Before submitting a new issue, please follow the checklist and try to find the answer. | ||
options: | ||
- Linux | ||
- MacOS | ||
- RaspberryPi OS | ||
- Windows 7 | ||
- Windows 10 | ||
- Windows 11 | ||
- Others | ||
validations: | ||
required: true | ||
|
||
- label: I have read the component documentation [ESP-IDF Components](https://components.espressif.com) and the issue is not addressed there. | ||
required: true | ||
- label: I am using target and esp-idf version as defined in component's idf_component.yml | ||
required: true | ||
- label: I have searched the [issue tracker](https://github.com/espressif/tinyusb/issues?q=is%3Aissue) for a similar issue and not found any related issue. | ||
required: true | ||
- type: input | ||
id: idf_version | ||
attributes: | ||
label: Board | ||
placeholder: e.g Feather nRF52840 Express | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Firmware | ||
placeholder: | | ||
e.g examples/device/cdc_msc. If it is custom firmware, it is preferably compiled like one in example folder and reviewable for people to comment on. The easiest way is | ||
- Fork this repo, checkout a new branch | ||
- Add your-own-example based on stock one | ||
- Push and post it here. | ||
label: ESP-IDF version. | ||
description: On which ESP-IDF version does this issue occur on? Run `git describe --tags` in your esp-idf folder to find it. | ||
placeholder: ex. v5.0-rc1 | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: What happened ? | ||
placeholder: A clear and concise description of what the bug is. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
- type: input | ||
id: devkit | ||
attributes: | ||
label: How to reproduce ? | ||
placeholder: | | ||
Exact steps in chronological order, details should be specific e.g if you use a command/script to test with, please post it as well. | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. See error | ||
label: Development Kit. | ||
description: On which Development Kit does this issue occur on? | ||
placeholder: ex. ESP32-Wrover-Kit v2 | Custom Board | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
- type: input | ||
id: component_version | ||
attributes: | ||
label: Debug Log as txt file (LOG/CFG_TUSB_DEBUG=2) | ||
placeholder: | | ||
Attach your debug log txt file here, where the issue occurred, best with comments to explain the actual events. | ||
Note1: Please DO NOT paste your lengthy log contents here since it hurts the readability. | ||
Note2: To enable logging, add `LOG=2` to to the make command if building with stock examples or set `CFG_TUSB_DEBUG=2` in your tusb_config.h. | ||
More information can be found at [example's readme](https://github.com/hathach/tinyusb/blob/master/docs/getting_started.md) | ||
label: Used Component version. | ||
description: On which Component version does this issue occur on? Check `dependencies.lock` file in your project root to find it. | ||
placeholder: ex. v1.2.0-rc0 | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: more-info | ||
attributes: | ||
label: Screenshots | ||
description: If applicable, add screenshots to help explain your problem. | ||
label: More Information. | ||
description: Do you have any other information from investigating this? | ||
placeholder: ex. I tried on my friend's Windows 10 PC and the command works there. | ||
validations: | ||
required: false | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: I have checked existing issues, dicussion and documentation | ||
description: You agree to check all the resources above before opening a new issue. | ||
options: | ||
- label: I confirm I have checked existing issues, dicussion and documentation. | ||
required: true |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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,17 @@ | ||
## Requirements | ||
_Provide a requirements for requesting changes_ | ||
|
||
## Limitations | ||
_Describe limitations if there are any_ | ||
|
||
## Breaking change | ||
_No breaking changes_ | ||
|
||
## Checklist | ||
|
||
- [ ] Pull Request name has appropriate format (for example: "fix(dcd_dwc2): Resolved address selection when several phy are present") | ||
- [ ] README.md updated | ||
- [ ] CI passing | ||
|
||
## Related issues | ||
_No related issues_ |
This file was deleted.
Oops, something went wrong.