|
1 | | -name: Bug Report |
2 | | -description: Report a problem with TinyUSB |
3 | | -labels: 'Bug 🐞' |
| 1 | +name: Bug report |
| 2 | +description: Report build and runtime bugs |
| 3 | +labels: ["Type: Bug"] |
4 | 4 | body: |
5 | | - - type: markdown |
6 | | - attributes: |
7 | | - value: | |
8 | | - Thanks for taking the time to fill out this bug report! |
9 | | - It's okay to leave some blank if it doesn't apply to your problem. |
10 | | -
|
11 | | - - type: dropdown |
| 5 | + - type: checkboxes |
| 6 | + id: checklist |
12 | 7 | attributes: |
13 | | - label: Operating System |
| 8 | + label: Answers checklist. |
| 9 | + description: Before submitting a new issue, please follow the checklist and try to find the answer. |
14 | 10 | options: |
15 | | - - Linux |
16 | | - - MacOS |
17 | | - - RaspberryPi OS |
18 | | - - Windows 7 |
19 | | - - Windows 10 |
20 | | - - Windows 11 |
21 | | - - Others |
22 | | - validations: |
23 | | - required: true |
24 | | - |
| 11 | + - label: I have read the component documentation [ESP-IDF Components](https://components.espressif.com) and the issue is not addressed there. |
| 12 | + required: true |
| 13 | + - label: I am using target and esp-idf version as defined in component's idf_component.yml |
| 14 | + required: true |
| 15 | + - 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. |
| 16 | + required: true |
25 | 17 | - type: input |
| 18 | + id: idf_version |
26 | 19 | attributes: |
27 | | - label: Board |
28 | | - placeholder: e.g Feather nRF52840 Express |
29 | | - validations: |
30 | | - required: true |
31 | | - |
32 | | - - type: textarea |
33 | | - attributes: |
34 | | - label: Firmware |
35 | | - placeholder: | |
36 | | - 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 |
37 | | - - Fork this repo, checkout a new branch |
38 | | - - Add your-own-example based on stock one |
39 | | - - Push and post it here. |
| 20 | + label: ESP-IDF version. |
| 21 | + description: On which ESP-IDF version does this issue occur on? Run `git describe --tags` in your esp-idf folder to find it. |
| 22 | + placeholder: ex. v5.0-rc1 |
40 | 23 | validations: |
41 | 24 | required: true |
42 | | - |
43 | | - - type: textarea |
44 | | - attributes: |
45 | | - label: What happened ? |
46 | | - placeholder: A clear and concise description of what the bug is. |
47 | | - validations: |
48 | | - required: true |
49 | | - |
50 | | - - type: textarea |
| 25 | + - type: input |
| 26 | + id: devkit |
51 | 27 | attributes: |
52 | | - label: How to reproduce ? |
53 | | - placeholder: | |
54 | | - 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. |
55 | | - 1. Go to '...' |
56 | | - 2. Click on '....' |
57 | | - 3. See error |
| 28 | + label: Development Kit. |
| 29 | + description: On which Development Kit does this issue occur on? |
| 30 | + placeholder: ex. ESP32-Wrover-Kit v2 | Custom Board |
58 | 31 | validations: |
59 | 32 | required: true |
60 | | - |
61 | | - - type: textarea |
| 33 | + - type: input |
| 34 | + id: component_version |
62 | 35 | attributes: |
63 | | - label: Debug Log as txt file (LOG/CFG_TUSB_DEBUG=2) |
64 | | - placeholder: | |
65 | | - Attach your debug log txt file here, where the issue occurred, best with comments to explain the actual events. |
66 | | -
|
67 | | - Note1: Please DO NOT paste your lengthy log contents here since it hurts the readability. |
68 | | - 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. |
69 | | - More information can be found at [example's readme](https://github.com/hathach/tinyusb/blob/master/docs/getting_started.md) |
| 36 | + label: Used Component version. |
| 37 | + description: On which Component version does this issue occur on? Check `dependencies.lock` file in your project root to find it. |
| 38 | + placeholder: ex. v1.2.0-rc0 |
70 | 39 | validations: |
71 | 40 | required: true |
72 | | - |
73 | 41 | - type: textarea |
| 42 | + id: more-info |
74 | 43 | attributes: |
75 | | - label: Screenshots |
76 | | - description: If applicable, add screenshots to help explain your problem. |
| 44 | + label: More Information. |
| 45 | + description: Do you have any other information from investigating this? |
| 46 | + placeholder: ex. I tried on my friend's Windows 10 PC and the command works there. |
77 | 47 | validations: |
78 | 48 | required: false |
79 | | - |
80 | | - - type: checkboxes |
81 | | - attributes: |
82 | | - label: I have checked existing issues, dicussion and documentation |
83 | | - description: You agree to check all the resources above before opening a new issue. |
84 | | - options: |
85 | | - - label: I confirm I have checked existing issues, dicussion and documentation. |
86 | | - required: true |
0 commit comments