Skip to content

Commit 0a48a55

Browse files
committed
add issue template
1 parent 6653744 commit 0a48a55

File tree

3 files changed

+120
-0
lines changed

3 files changed

+120
-0
lines changed
Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
name: Bug Report
2+
description: Report a problem
3+
labels: 'Bug'
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
12+
attributes:
13+
label: Operating System
14+
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+
25+
- type: input
26+
attributes:
27+
label: Arduino IDE version
28+
placeholder: e.g Arduino 1.8.15
29+
validations:
30+
required: true
31+
32+
- type: input
33+
attributes:
34+
label: Board
35+
placeholder: e.g Metro M4 Express
36+
validations:
37+
required: true
38+
39+
- type: input
40+
attributes:
41+
label: ArduinoCore version
42+
description: Can be found under "Board Manager" menu
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
attributes:
48+
label: Sketch as ATTACHED TXT
49+
placeholder: |
50+
e.g examples/MassStorage/msc_ramdisk.
51+
If it is custom sketch, please provide it as **ATTACHED** files or link to it.
52+
Pasting raw long code that hurts readability can get your issue **closed**
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
attributes:
58+
label: Compiled Log as ATTACHED TXT
59+
placeholder: |
60+
Compiled log from Arduino IDE as **ATTACHED** txt.
61+
Pasting raw long log that hurts readability can get your issue **closed**
62+
validations:
63+
required: true
64+
65+
- type: textarea
66+
attributes:
67+
label: What happened ?
68+
placeholder: A clear and concise description of what the bug is.
69+
validations:
70+
required: true
71+
72+
- type: textarea
73+
attributes:
74+
label: How to reproduce ?
75+
placeholder: |
76+
1. Go to '...'
77+
2. Click on '....'
78+
3. See error
79+
validations:
80+
required: true
81+
82+
- type: textarea
83+
attributes:
84+
label: Debug Log as ATTACHED TXT
85+
placeholder: |
86+
Debug log where the issue occurred as attached txt file, best with comments to explain the actual events.
87+
validations:
88+
required: false
89+
90+
- type: textarea
91+
attributes:
92+
label: Screenshots
93+
description: If applicable, add screenshots to help explain your problem.
94+
validations:
95+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Adafruit Support Forum
4+
url: https://forums.adafruit.com
5+
about: If you have other questions or need help, post it here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: Feature
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)