Skip to content

Commit bcbe5e1

Browse files
committed
New bug report form
1 parent cae4f4e commit bcbe5e1

File tree

2 files changed

+203
-86
lines changed

2 files changed

+203
-86
lines changed
Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
name: "🐛 Bug Report"
2+
description: If something isn't working as expected 🤔.
3+
title: "[Bug]: "
4+
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**Thanks for reporting an issue!**
10+
11+
**Issues are expected to lead to changes in the repository, like code or documentation improvements or bug fixes.**
12+
If you have handling problems or questions, consider to post in [Discussions](../discussions) instead.
13+
14+
# Environment
15+
16+
- type: dropdown
17+
id: Board
18+
attributes:
19+
label: The type of board you are using.
20+
options:
21+
- Arduino ATmega328* board (UNO, Nano, etc.)
22+
- Arduino ATmega2560 board (Mega)
23+
- Arduino ATmega32U4 board (Leonardo, etc.)
24+
- Arduino megaAVR board (NanoEvery)
25+
- Arduino SAM board (Due)
26+
- Arduino SAMD board (Zero, MKR*)
27+
- ATtiny85 board (ATTinyCore by Spence Conde)
28+
- Digispark board
29+
- ATtiny3217 board (TinyCore)
30+
- ESP32 board - first check https://github.com/crankyoldgit/IRremoteESP8266
31+
- STM32F1 board (BluePill)
32+
- Teensy board
33+
- Other - please specify below
34+
validations:
35+
required: true
36+
37+
- type: dropdown
38+
id: IDE
39+
attributes:
40+
label: What IDE are you using?
41+
options:
42+
- Arduino IDE
43+
- Arduino Web Editor
44+
- Arduino Pro IDE
45+
- Sloeber IDE
46+
- PlatformIO IDE
47+
- Other - please specify below
48+
multiple: false
49+
validations:
50+
required: true
51+
52+
- type: dropdown
53+
id: IR_Protocol
54+
attributes:
55+
label: What IR protocol are you using?
56+
options:
57+
- Unknown
58+
- BoseWave
59+
- Denon
60+
- Dish
61+
- JVC
62+
- Lego
63+
- LG
64+
- NEC
65+
- Panasonic
66+
- RC5, RC6
67+
- Samsung
68+
- Sharp
69+
- Sony
70+
- Whynter
71+
- Other - please specify below
72+
multiple: true
73+
validations:
74+
required: true
75+
76+
- type: input
77+
id: IR_Pin
78+
attributes:
79+
label: Pin(s) used for IR-receive, if not default.
80+
value: "Arduino pin number: "
81+
validations:
82+
required: false
83+
84+
- type: checkboxes
85+
id: Checked_examples
86+
attributes:
87+
label: Example(s) you have checked while hunting the bug.
88+
description: Please do not submit a bug report without testing at least one or more examples!
89+
options:
90+
- label: SimpleReceiver
91+
- label: ReceiveDemo
92+
- label: SendRawDemo
93+
- label: ReceiverTimingAnalysis
94+
- label: MinimalReceiver
95+
- label: ReceiveAndSend
96+
- label: SimpleSender
97+
- label: SendDemo
98+
- label: SendLGAirConditionerDemo
99+
- label: UnitTest
100+
- label: Other - please specify below
101+
- label: I checked, if at least one of the examples was working.
102+
required: true
103+
104+
- type: checkboxes
105+
id: Failed_examples
106+
attributes:
107+
label: Example(s) to reproduce the issue.
108+
description: Select only the examples which shows your error.
109+
options:
110+
- label: SimpleReceiver
111+
- label: ReceiveDemo
112+
- label: SendRawDemo
113+
- label: ReceiverTimingAnalysis
114+
- label: MinimalReceiver
115+
- label: ReceiveAndSend
116+
- label: SimpleSender
117+
- label: SendDemo
118+
- label: SendLGAirConditionerDemo
119+
- label: UnitTest
120+
- label: Other - please specify below
121+
122+
- type: checkboxes
123+
id: Version
124+
attributes:
125+
label: The library version you are working with.
126+
description: |
127+
You may use the latest repo version, which is not (yet) released, but may contain some bugfixes.
128+
Your current library version number can be found with *Arduino > Tools > Manage Libraries..* (Ctrl+Shift+I)
129+
and is printed to serial output at the startup of every example.
130+
options:
131+
- label: I use the [latest Arduino library version](../releases) and verified this!
132+
- label: I use the latest repo version ([download link](../archive/master.zip)) and verified this!
133+
134+
- type: markdown
135+
attributes:
136+
value: |
137+
# Bug descripion
138+
139+
- type: textarea
140+
id: bug-steps
141+
attributes:
142+
label: What are the steps to reproduce this issue?
143+
placeholder: |
144+
1.
145+
2.
146+
3.
147+
4. See error
148+
validations:
149+
required: true
150+
151+
- type: textarea
152+
id: bug-description
153+
attributes:
154+
label: What happens?
155+
description: A clear and concise description of what the bug is.
156+
validations:
157+
required: true
158+
159+
- type: textarea
160+
id: bug-logs
161+
attributes:
162+
label: The serial output which indicates the error happened.
163+
description: |
164+
Please copy and paste any relevant serial output. This will be automatically formatted into code, so no need for backticks.
165+
render: shell
166+
validations:
167+
required: false
168+
169+
- type: textarea
170+
id: bug-expectation
171+
attributes:
172+
label: What were you expecting to happen?
173+
description: A clear and concise description of what was supposed to happen.
174+
validations:
175+
required: false
176+
177+
- type: textarea
178+
id: bug-context
179+
attributes:
180+
label: Additional context.
181+
description: Add any other context you can provide about the problem here.
182+
validations:
183+
required: false
184+
185+
- type: markdown
186+
attributes:
187+
value: |
188+
# Checklist
189+
190+
- type: checkboxes
191+
id: Commitments
192+
attributes:
193+
label: Final checklist for the bug report.
194+
options:
195+
- label: I have **read** the README.md file thoroughly
196+
required: true
197+
- label: I have searched existing issues to see if there is anything I have missed.
198+
required: true
199+
- label: I have browsed the examples for one, that matches my use case.
200+
required: true
201+
- label: The title of the issue is helpful and relevant.
202+
required: true
203+

.github/issue_template.md

Lines changed: 0 additions & 86 deletions
This file was deleted.

0 commit comments

Comments
 (0)