Skip to content

Commit 3806205

Browse files
committed
Create Issue Template
1 parent 16e5fec commit 3806205

File tree

2 files changed

+117
-0
lines changed

2 files changed

+117
-0
lines changed

.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: true
2+
contact_links:
3+
- name: Bytebeam Support
4+
url: mailto:support@bytebeam.io
5+
about: Reach out to bytebeam support team
Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
name: Issue report
2+
description: Report any problem here
3+
labels: ["Status: Awaiting triage"]
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 [Bytebeam Arduino Docs](https://docs.bytebeam.io/docs/arduino) and the issue is not addressed there.
12+
required: true
13+
- label: I have gone through [Existing Isssues](https://github.com/bytebeamio/bytebeam-arduino-sdk/issues) for a similar issue and not found a similar issue.
14+
required: true
15+
- type: input
16+
id: board
17+
attributes:
18+
label: Board
19+
description: On which Board does this issue occur?
20+
placeholder: eg. ESP32 Dev Module, ESP32-S2, NodeMCU 1.0 (ESP-12E Module)...
21+
validations:
22+
required: true
23+
- type: textarea
24+
id: devboard
25+
attributes:
26+
label: Device Description
27+
description: What development board or other hardware is the chip attached to?
28+
placeholder: ex. DevKitC, plain module on breadboard, etc. If your hardware is custom or unusual, please attach a photo.
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: other-hw
33+
attributes:
34+
label: Hardware Configuration
35+
description: Is anything else attached to the development board?
36+
placeholder: ex. GPIO 18 & 19 are connected to I2C devices.
37+
validations:
38+
required: true
39+
- type: input
40+
id: arduino-esp32-version
41+
attributes:
42+
label: Arduino-ESP32 Version
43+
description: What version of Arduino ESP32 are you running? If possible, consider updating to the latest version.
44+
validations:
45+
required: true
46+
- type: dropdown
47+
id: bytebeam-arduino-sdk-version
48+
attributes:
49+
label: Bytebeam Arduino SDK Version
50+
description: What version of Bytebeam Arduino SDK are you running? If possible, consider updating to the latest version.
51+
options:
52+
- latest main (checkout manually)
53+
- 1.0.1
54+
- 1.0.0
55+
validations:
56+
required: true
57+
- type: input
58+
id: ide
59+
attributes:
60+
label: IDE Name
61+
description: What IDE are you using?
62+
placeholder: eg. Arduino IDE, PlatformIO, Sloeber...
63+
validations:
64+
required: true
65+
- type: input
66+
id: host-os
67+
attributes:
68+
label: Operating System
69+
description: On which OS does this issue occur?
70+
placeholder: ex. macOS 12.1, Windows 10...
71+
validations:
72+
required: true
73+
- type: textarea
74+
id: problem-escription
75+
attributes:
76+
label: Problem Description
77+
description: Please describe your problem here and expected behaviour
78+
placeholder: ex. Can't connect/weird behaviour/wrong function/missing parameter..
79+
validations:
80+
required: true
81+
- type: textarea
82+
id: sketch
83+
attributes:
84+
label: Sketch
85+
description: Please provide full minimal sketch/code which can be run to reproduce your issue
86+
placeholder: ex. Related part of the code to replicate the issue
87+
render: cpp
88+
validations:
89+
required: true
90+
- type: textarea
91+
id: Debug
92+
attributes:
93+
label: Debug Message
94+
description: Please provide a debug message or error message. If you have a Guru Meditation Error or Backtrace, please decode it with [ExceptionDecoder](https://github.com/me-no-dev/EspExceptionDecoder)
95+
placeholder: Set Bytebeam Arduino Logger to debug level - Use BytebeamLogger::LOG_DEBUG in begin method, then put the serial output here.
96+
render: plain
97+
validations:
98+
required: true
99+
- type: textarea
100+
id: other-remarks
101+
attributes:
102+
label: More Information
103+
description: Is there any other information you can think of which will help us reproduce this problem? Any additional info can be added as well.
104+
placeholder: ex. I also tried on other OS, HW...it works correctly on that setup.
105+
- type: checkboxes
106+
id: confirmation
107+
attributes:
108+
label: I have checked existing issues, online documentation and the Troubleshooting Guide
109+
description: You agree to check all the resources above before opening a new issue.
110+
options:
111+
- label: I confirm I have checked existing issues and online documentation.
112+
required: true

0 commit comments

Comments
 (0)