summaryrefslogtreecommitdiff
path: root/lib/Adafruit_Python_CharLCD/.github
diff options
context:
space:
mode:
authorCody Hiar <codyfh@gmail.com>2018-05-27 15:29:21 -0600
committerCody Hiar <codyfh@gmail.com>2018-05-27 15:29:21 -0600
commitceec171c42bd79f1762b971569e20ead656f4fd0 (patch)
tree1880be0b1cef9786be5bc818cbd50095cd797a6d /lib/Adafruit_Python_CharLCD/.github
parent611a8b7be4331e4f8416c4d10a0be47a109b47e4 (diff)
Moving libs into separate own directory
Diffstat (limited to 'lib/Adafruit_Python_CharLCD/.github')
-rw-r--r--lib/Adafruit_Python_CharLCD/.github/ISSUE_TEMPLATE.md47
-rw-r--r--lib/Adafruit_Python_CharLCD/.github/PULL_REQUEST_TEMPLATE.md26
2 files changed, 73 insertions, 0 deletions
diff --git a/lib/Adafruit_Python_CharLCD/.github/ISSUE_TEMPLATE.md b/lib/Adafruit_Python_CharLCD/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 0000000..6344b2f
--- /dev/null
+++ b/lib/Adafruit_Python_CharLCD/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,47 @@
+Thank you for opening an issue on an Adafruit Python library repository. To
+improve the speed of resolution please review the following guidelines and
+common troubleshooting steps below before creating the issue:
+
+- **Do not use GitHub issues for troubleshooting projects and issues.** Instead use
+ the forums at http://forums.adafruit.com to ask questions and troubleshoot why
+ something isn't working as expected. In many cases the problem is a common issue
+ that you will more quickly receive help from the forum community. GitHub issues
+ are meant for known defects in the code. If you don't know if there is a defect
+ in the code then start with troubleshooting on the forum first.
+
+- **If following a tutorial or guide be sure you didn't miss a step.** Carefully
+ check all of the steps and commands to run have been followed. Consult the
+ forum if you're unsure or have questions about steps in a guide/tutorial.
+
+- **For Python/Raspberry Pi projects check these very common issues to ensure they don't apply**:
+
+ - If you are receiving an **ImportError: No module named...** error then a
+ library the code depends on is not installed. Check the tutorial/guide or
+ README to ensure you have installed the necessary libraries. Usually the
+ missing library can be installed with the `pip` tool, but check the tutorial/guide
+ for the exact command.
+
+ - **Be sure you are supplying adequate power to the board.** Check the specs of
+ your board and power in an external power supply. In many cases just
+ plugging a board into your computer is not enough to power it and other
+ peripherals.
+
+ - **Double check all soldering joints and connections.** Flakey connections
+ 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.
+
+If you're sure this issue is a defect in the code and checked the steps above
+please fill in the following fields to provide enough troubleshooting information.
+You may delete the guideline and text above to just leave the following details:
+
+- Platform/operating system (i.e. Raspberry Pi with Raspbian operating system,
+ Windows 32-bit, Windows 64-bit, Mac OSX 64-bit, etc.): **INSERT PLATFORM/OPERATING
+ SYSTEM HERE**
+
+- Python version (run `python -version` or `python3 -version`): **INSERT PYTHON
+ VERSION HERE**
+
+- Error message you are receiving, including any Python exception traces: **INSERT
+ ERROR MESAGE/EXCEPTION TRACES HERE***
+
+- List the steps to reproduce the problem below (if possible attach code or commands
+ to run): **LIST REPRO STEPS BELOW**
diff --git a/lib/Adafruit_Python_CharLCD/.github/PULL_REQUEST_TEMPLATE.md b/lib/Adafruit_Python_CharLCD/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..7b641eb
--- /dev/null
+++ b/lib/Adafruit_Python_CharLCD/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,26 @@
+Thank you for creating a pull request to contribute to Adafruit's GitHub code!
+Before you open the request please review the following guidelines and tips to
+help it be more easily integrated:
+
+- **Describe the scope of your change--i.e. what the change does and what parts
+ of the code were modified.** This will help us understand any risks of integrating
+ the code.
+
+- **Describe any known limitations with your change.** For example if the change
+ doesn't apply to a supported platform of the library please mention it.
+
+- **Please run any tests or examples that can exercise your modified code.** We
+ strive to not break users of the code and running tests/examples helps with this
+ process.
+
+Thank you again for contributing! We will try to test and integrate the change
+as soon as we can, but be aware we have many GitHub repositories to manage and
+can't immediately respond to every request. There is no need to bump or check in
+on a pull request (it will clutter the discussion of the request).
+
+Also don't be worried if the request is closed or not integrated--sometimes the
+priorities of Adafruit's GitHub code (education, ease of use) might not match the
+priorities of the pull request. Don't fret, the open source community thrives on
+forks and GitHub makes it easy to keep your changes in a forked repo.
+
+After reviewing the guidelines above you can delete this text from the pull request.