Skip to content
This repository was archived by the owner on Oct 26, 2019. It is now read-only.

Commit a3f1a75

Browse files
committed
Add GitHub issue template
1 parent 4c380f8 commit a3f1a75

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

.github/ISSUE_TEMPLATE.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
Thank you for opening an issue on an Adafruit Python 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 Python/Raspberry Pi projects check these very common issues to ensure they don't apply**:
17+
18+
- If you are receiving an **ImportError: No module named...** error then a
19+
library the code depends on is not installed. Check the tutorial/guide or
20+
README to ensure you have installed the necessary libraries. Usually the
21+
missing library can be installed with the `pip` tool, but check the tutorial/guide
22+
for the exact command.
23+
24+
- **Be sure you are supplying adequate power to the board.** Check the specs of
25+
your board and power 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+
If you're sure this issue is a defect in the code and checked the steps above
33+
please fill in the following fields to provide enough troubleshooting information.
34+
You may delete the guideline and text above to just leave the following details:
35+
36+
- Platform/operating system (i.e. Raspberry Pi with Raspbian operating system,
37+
Windows 32-bit, Windows 64-bit, Mac OSX 64-bit, etc.): **INSERT PLATFORM/OPERATING
38+
SYSTEM HERE**
39+
40+
- Python version (run `python -version` or `python3 -version`): **INSERT PYTHON
41+
VERSION HERE**
42+
43+
- Error message you are receiving, including any Python exception traces: **INSERT
44+
ERROR MESAGE/EXCEPTION TRACES HERE***
45+
46+
- List the steps to reproduce the problem below (if possible attach code or commands
47+
to run): **LIST REPRO STEPS BELOW**

0 commit comments

Comments
 (0)