Skip to content

Commit cba227a

Browse files
committed
change(tinyusb): Added repo templates for issue and pull request
1 parent fc869d3 commit cba227a

File tree

8 files changed

+139
-143
lines changed

8 files changed

+139
-143
lines changed
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Bug report
2+
description: Report build and runtime bugs
3+
labels: ["Type: Bug"]
4+
body:
5+
- type: checkboxes
6+
id: checklist
7+
attributes:
8+
label: Answers checklist.
9+
description: Before submitting a new issue, please follow the checklist and try to find the answer.
10+
options:
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/esp-usb/issues?q=is%3Aissue) for a similar issue and not found any related issue.
16+
required: true
17+
- type: dropdown
18+
id: component
19+
attributes:
20+
label: Which component are you using? If you choose Other, provide details in More Information.
21+
multiple: false
22+
options:
23+
- device/esp_tinyusb
24+
- host/cdc
25+
- host/hid
26+
- host/msc
27+
- host/uvc
28+
- Other
29+
validations:
30+
required: true
31+
- type: input
32+
id: idf_version
33+
attributes:
34+
label: ESP-IDF version.
35+
description: On which ESP-IDF version does this issue occur on? Run `git describe --tags` in your esp-idf folder to find it.
36+
placeholder: ex. v5.0-rc1
37+
validations:
38+
required: true
39+
- type: input
40+
id: devkit
41+
attributes:
42+
label: Development Kit.
43+
description: On which Development Kit does this issue occur on?
44+
placeholder: ex. ESP32-Wrover-Kit v2 | Custom Board
45+
validations:
46+
required: true
47+
- type: input
48+
id: component_version
49+
attributes:
50+
label: Used Component version.
51+
description: On which Component version does this issue occur on? Check `dependencies.lock` file in your project root to find it.
52+
placeholder: ex. v1.2.0-rc0
53+
validations:
54+
required: true
55+
- type: textarea
56+
id: more-info
57+
attributes:
58+
label: More Information.
59+
description: Do you have any other information from investigating this?
60+
placeholder: ex. I tried on my friend's Windows 10 PC and the command works there.
61+
validations:
62+
required: false

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 0 additions & 86 deletions
This file was deleted.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Component Registry
4+
url: https://components.espressif.com
5+
about: Registry with all available ESP-IDF components.
6+
- name: ESP-IDF Programming Guide
7+
url: https://docs.espressif.com/projects/esp-idf/en/latest/
8+
about: Documentation for configuring and using ESP-IDF.
9+
- name: Espressif documentation page
10+
url: https://www.espressif.com/en/support/download/documents
11+
about: Hardware documentation (datasheets, Technical Reference Manual, etc).
12+
- name: Forum
13+
url: https://esp32.com
14+
about: For questions about using ESP-IDF and/or ESP32 series chips. Please submit all questions starting "How do I..." here.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 0 additions & 8 deletions
This file was deleted.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Feature request
2+
description: Suggest an idea or new component 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’s 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/esp-usb/labels/Type%3A%20Feature%20Request), feel free to add comments to them.
10+
- type: textarea
11+
id: problem-related
12+
attributes:
13+
label: Is your feature request related to a problem?
14+
description: Please provide a clear and concise description of what the problem is.
15+
placeholder: ex. I'm always frustrated when ...
16+
- type: textarea
17+
id: solution
18+
attributes:
19+
label: Describe the solution you'd like.
20+
description: Please provide a clear and concise description of what you want to happen.
21+
placeholder: ex. When building my application ...
22+
- type: textarea
23+
id: alternatives
24+
attributes:
25+
label: Describe alternatives you've considered.
26+
description: Please provide a clear and concise description of any alternative solutions or features you've considered.
27+
placeholder: ex. Choosing other approach wouldn't work, because ...
28+
- type: textarea
29+
id: context
30+
attributes:
31+
label: Additional context.
32+
description: Please add any other context or screenshots about the feature request here.
33+
placeholder: ex. This would work only when ...

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 0 additions & 49 deletions
This file was deleted.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: General issue report
2+
description: File an issue report
3+
body:
4+
- type: checkboxes
5+
id: checklist
6+
attributes:
7+
label: Answers checklist.
8+
description: Before submitting a new issue, please follow the checklist and try to find the answer.
9+
options:
10+
- label: I have read the documentation of the component in question and the issue is not addressed there.
11+
required: true
12+
- label: I have searched the issue tracker for a similar issue and not found a similar issue.
13+
required: true
14+
- type: textarea
15+
id: issue
16+
attributes:
17+
label: General issue report
18+
description: Your issue report goes here.
19+
placeholder: ex. How do I...
20+
validations:
21+
required: true
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Checklist
2+
3+
- [ ] Version in idf_component.yml file bumped
4+
- [ ] CHANGELOG.md entry added
5+
- [ ] _Optional:_ README.md updated
6+
- [ ] CI passing
7+
8+
# Change description
9+
_Please describe your change here_

0 commit comments

Comments
 (0)