Skip to content

Commit a2050ac

Browse files
david-cermakdavid-cermak
authored
Merge pull request #233 from tom-borcin/feature/add_issue_templates
Add issue templates
2 parents 6015c19 + 5df8fdb commit a2050ac

File tree

4 files changed

+121
-0
lines changed

4 files changed

+121
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Installation or build bug report
2+
description: Report installation or build 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 documentation for [esp-protocols components](https://espressif.github.io/esp-protocols/) and the issue is not addressed there.
12+
required: true
13+
- label: I have updated my esp-protocols branch (master or release) to the latest version and checked that the issue is present there.
14+
required: true
15+
- label: I have searched the issue tracker for a similar issue and not found a similar issue.
16+
required: true
17+
- type: dropdown
18+
id: component
19+
attributes:
20+
label: What component are you using? If you choose Other, provide details in More Information.
21+
multiple: false
22+
options:
23+
- ASIO port
24+
- esp_modem
25+
- esp_websocket_client
26+
- mDNS
27+
- Other
28+
validations:
29+
required: true
30+
- type: input
31+
id: component_id
32+
attributes:
33+
label: component version
34+
description: Which component version does this issue occur on? (see your `idf_component.yml`)
35+
placeholder: ex. 1.0.0
36+
- type: input
37+
id: idf_version
38+
attributes:
39+
label: IDF version.
40+
description: On which IDF version does this issue occur on? Run `git describe --tags` to find it.
41+
placeholder: ex. v3.2-dev-1148-g96cd3b75c
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: more-info
46+
attributes:
47+
label: More Information.
48+
description: Do you have any other information from investigating this?
49+
placeholder: ex. I tried on my friend's Windows 10 PC and the command works there.
50+
validations:
51+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

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: esp-protocols documentation
4+
url: https://espressif.github.io/esp-protocols/
5+
about: Documenation for esp-protocols 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/feature-request.yml‎

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-protocols/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/other-issue.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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 for [esp-protocols components](https://espressif.github.io/esp-protocols/) and the issue is not addressed there.
11+
required: true
12+
- label: I have updated my esp-protocols branch (master or release) to the latest version and checked that the issue is present there.
13+
required: true
14+
- label: I have searched the issue tracker for a similar issue and not found a similar issue.
15+
required: true
16+
- type: textarea
17+
id: issue
18+
attributes:
19+
label: General issue report
20+
description: Your issue report goes here.
21+
placeholder: ex. How do I...
22+
validations:
23+
required: true

0 commit comments

Comments
 (0)