Skip to content

Commit a5d794c

Browse files
committed
Add GitHub issue template
1 parent 45f1ee3 commit a5d794c

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

.github/ISSUE_TEMPLATE.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
Thank you for opening an issue on an Adafruit Arduino library repository. To
2+
improve the speed of resolution please review the following guidelines and
3+
common troubleshooting steps below before creating the issue:
4+
5+
- **Do not use GitHub issues for troubleshooting projects and issues.** Instead use
6+
the forums at http://forums.adafruit.com to ask questions and troubleshoot why
7+
something isn't working as expected. In many cases the problem is a common issue
8+
that you will more quickly receive help from the forum community. GitHub issues
9+
are meant for known defects in the code. If you don't know if there is a defect
10+
in the code then start with troubleshooting on the forum first.
11+
12+
- **If following a tutorial or guide be sure you didn't miss a step.** Carefully
13+
check all of the steps and commands to run have been followed. Consult the
14+
forum if you're unsure or have questions about steps in a guide/tutorial.
15+
16+
- **For Arduino projects check these very common issues to ensure they don't apply**:
17+
18+
- For uploading sketches or communicating with the board make sure you're using
19+
a **USB data cable** and **not** a **USB charge-only cable**. It is sometimes
20+
very hard to tell the difference between a data and charge cable! Try using the
21+
cable with other devices or swapping to another cable to confirm it is not
22+
the problem.
23+
24+
- **Be sure you are supplying adequate power to the board.** Check the specs of
25+
your board and plug in an external power supply. In many cases just
26+
plugging a board into your computer is not enough to power it and other
27+
peripherals.
28+
29+
- **Double check all soldering joints and connections.** Flakey connections
30+
cause many mysterious problems. See the [guide to excellent soldering](https://learn.adafruit.com/adafruit-guide-excellent-soldering/tools) for examples of good solder joints.
31+
32+
- **Ensure you are using an official Arduino or Adafruit board.** We can't
33+
guarantee a clone board will have the same functionality and work as expected
34+
with this code and don't support them.
35+
36+
If you're sure this issue is a defect in the code and checked the steps above
37+
please fill in the following fields to provide enough troubleshooting information.
38+
You may delete the guideline and text above to just leave the following details:
39+
40+
- Arduino board: **INSERT ARDUINO BOARD NAME/TYPE HERE**
41+
42+
- Arduino IDE version (found in Arduino -> About Arduino menu): **INSERT ARDUINO
43+
VERSION HERE**
44+
45+
- List the steps to reproduce the problem below (if possible attach a sketch or
46+
copy the sketch code in too): **LIST REPRO STEPS BELOW**

0 commit comments

Comments
 (0)