ISSUE_TEMPLATE.md
1 <!-- SPDX-FileCopyrightText: 2019 Nicholas Tollervey, written for Adafruit Industries 2 3 SPDX-License-Identifier: MIT --> 4 Thank you for opening an issue on an Adafruit Python library repository. To 5 improve the speed of resolution please review the following guidelines and 6 common troubleshooting steps below before creating the issue: 7 8 - **Do not use GitHub issues for troubleshooting projects and issues.** Instead use 9 the forums at http://forums.adafruit.com to ask questions and troubleshoot why 10 something isn't working as expected. In many cases the problem is a common issue 11 that you will more quickly receive help from the forum community. GitHub issues 12 are meant for known defects in the code. If you don't know if there is a defect 13 in the code then start with troubleshooting on the forum first. 14 15 - **If following a tutorial or guide be sure you didn't miss a step.** Carefully 16 check all of the steps and commands to run have been followed. Consult the 17 forum if you're unsure or have questions about steps in a guide/tutorial. 18 19 - **For Python/Raspberry Pi projects check these very common issues to ensure they don't apply**: 20 21 - If you are receiving an **ImportError: No module named...** error then a 22 library the code depends on is not installed. Check the tutorial/guide or 23 README to ensure you have installed the necessary libraries. Usually the 24 missing library can be installed with the `pip` tool, but check the tutorial/guide 25 for the exact command. 26 27 - **Be sure you are supplying adequate power to the board.** Check the specs of 28 your board and power in an external power supply. In many cases just 29 plugging a board into your computer is not enough to power it and other 30 peripherals. 31 32 - **Double check all soldering joints and connections.** Flakey connections 33 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. 34 35 If you're sure this issue is a defect in the code and checked the steps above 36 please fill in the following fields to provide enough troubleshooting information. 37 You may delete the guideline and text above to just leave the following details: 38 39 - Platform/operating system (i.e. Raspberry Pi with Raspbian operating system, 40 Windows 32-bit, Windows 64-bit, Mac OSX 64-bit, etc.): **INSERT PLATFORM/OPERATING 41 SYSTEM HERE** 42 43 - Python version (run `python -version` or `python3 -version`): **INSERT PYTHON 44 VERSION HERE** 45 46 - Error message you are receiving, including any Python exception traces: **INSERT 47 ERROR MESAGE/EXCEPTION TRACES HERE*** 48 49 - List the steps to reproduce the problem below (if possible attach code or commands 50 to run): **LIST REPRO STEPS BELOW**