Add contributor/issue docs

.github/CONTRIBUTING.md

@@ -0,0 +1,112 @@
+# Help us to help you! <!-- omit in toc -->
+
+Thank you for taking the time to contribute!
+
+- [Suggesting a feature](#suggesting-a-feature)
+- [Filing a bug report](#filing-a-bug-report)
+- [Submitting a pull request](#submitting-a-pull-request)
+  - [Do](#do)
+  - [Don't](#dont)
+  - [If you're submitting an example](#if-youre-submitting-an-example)
+  - [Licensing](#licensing)
+  - [Submitting your code](#submitting-your-code)
+- [Thank you!](#thank-you)
+
+## Suggesting a feature
+
+We can't think of everything- please let us know if you've got a good idea for a feature.
+
+Feature suggestions are embraced, but will often be filed for a rainy day. If you require a feature urgently, have a crack at writing it yourself! Don't forget to share ;)
+
+When suggesting a feature, make sure to:
+
+* Check the branches on GitHub to make sure it's not already hiding in an unreleased version
+* Consider if it should be part of the library library, or is an advanced technique that could be better explained in an example
+* Check existing issues, open and closed, to make sure it hasn't already been suggested & discussed
+
+## Filing a bug report
+
+If you're having trouble with our code/libraries/products on your Raspberry Pi:
+
+* Try asking on our forums (https://forums.pimoroni.com) or Discord (https://discord.gg/hr93ByC).
+* Check existing issues, open and closed, to make sure it hasn't already been suggested & discussed.
+* If all else fails, raise an issue against this repository.
+
+If you're reporting a bug, please tell us:
+
+* Your model of Raspberry Pi
+* Which OS you're using: `lsb_release -d`
+* Which Kernel you're running: `uname -a`
+* The steps you've taken so far
+* Any solutions you've tried
+
+Include a paste/screenshot of the complete output from the failing script/library if applicable!
+
+We have a diagnostic script: `curl get.pimoroni.com/diagnostic | bash` to help you gather information.
+
+## Submitting a pull request
+
+If you've decided to fix a bug, even something as small as a single-letter typo, then great! Anything that improves the code/documentation for all future users is warmly welcomed.
+
+If you decide to work on a requested feature it's best to let us (and everyone else) know what you're working on to avoid any duplication of effort. You can do this by replying to the original Issue for the request.
+
+If you want to contribute an example; go for it! We might not always be able to accept your code, but there's a lot to be learned from trying anyway. If you're new to GitHub we're willing to guide you on that journey.
+
+When contributing a new example or making a change to a library please keep your code style consistent with ours. We try to stick to the pep8 guidelines for Python (https://www.python.org/dev/peps/pep-0008/).
+
+### Do
+
+* Use pep8 style guidelines
+* Comment your code where necessary
+* Submit only a single example/feature per pull-request
+* Include a description of what your example is expected to do
+* Add details of your example to examples/README.md if it exists
+
+### Don't
+
+* Don't include any license information in your examples- our repositories are MIT licensed
+* Don't try to do too much at once- submit one or two examples at a time, and be receptive to feedback
+* Don't submit multiple variations of the same example, demonstrate one thing concisely
+
+### If you're submitting an example
+
+Try to do one thing, and do it concisely. Keep it simple. Don't mix too many ideas.
+
+The ideal example should:
+
+* Demonstrate one idea, technique or API as concisely as possible in a single Python script
+* *Just work* when you run it. Although sometimes configuration is necessary
+* Be well commented and attempt to teach the user how and why it works
+* Document any required configuration, and how to install API keys, dependencies, etc
+
+If you have a more complex example that uses multiple HATs/pHATs or consists of multiple files then consider submitting it as a project instead- either by creating your own GitHub repository and adding the link to the README.md, or by creating a subfolder in the projects/ directory for your code. For example:
+
+* https://github.com/pimoroni/unicorn-hat-hd/tree/master/projects/unicornpaint
+* https://github.com/pimoroni/phat-beat/tree/master/projects/vlc-radio
+
+And don't forget to shout about your example on our forums/twitter so we can signal-boost you and let everyone know how awesome you are!
+
+### Licensing
+
+When you submit code to our libraries, you implicitly and irrevocably agree to adopt the associated licenses. You should be able to find this in the file named `LICENSE`.
+
+We typically use the MIT license; which permits Commercial Use, Modification, Distribution and Private use of our code, and therefore also your contributions. It also provides good compatibility with other licenses, and is intended to make re-use of our code as painless as possible for all parties, no matter what they might do with it.
+
+You can learn more about the MIT license at Wikipedia: https://en.wikipedia.org/wiki/MIT_License
+
+### Submitting your code
+
+Once you're ready to share your contribution with us you should submit it as a Pull Request.
+
+* Be ready to receive and embrace constructive feedback.
+* Be prepared for rejection; we can't always accept contributions. If you're unsure, ask first!
+
+## Thank you!
+
+If you have any questions, concerns or comments about these guidelines, please get in touch. You can do this by raising an issue against our boilerplate Python repository here: https://github.com/pimoroni/boilerplate-python
+
+Above all else, we hope you enjoy yourself, learn things and make and share great contributions.
+
+Happy hacking!
+
+-- The Pirate Crew

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,29 @@
+## General Issues & Questions
+
+If you're having trouble with our code/libraries/products on your Raspberry Pi try asking on our forums (https://forums.pimoroni.com) or Discord (https://discord.gg/hr93ByC).
+
+If all else fails:
+
+## Bug Reports
+
+If you're reporting a bug, please tell us:
+
+* Your model of Raspberry Pi
+* Which OS you're using: `lsb_release -d`
+* Which Kernel you're running: `uname -a`
+* The steps you've taken so far
+* Any solutions you've tried
+
+Include a paste/screenshot of the complete output from the failing script/library if applicable!
+
+We have a diagnostic script: `curl get.pimoroni.com/diagnostic | bash` to help you gather information.
+
+Ready? Please delete this text and let us know what's troubling you!
+
+## Feature Requests
+
+If you've got some programming know-how, why not have a go at implementing a feature yourself and submit it as a pull-request?
+
+We're always happy to talk you through refining your code to make it suitable for inclusion.
+
+-- The Pirate Crew

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,62 @@
+# Submitting a pull request <!-- omit in toc -->
+
+If you've decided to fix a bug, even something as small as a single-letter typo, then great! Anything that improves the code/documentation for all future users is warmly welcomed.
+
+If you decide to work on a requested feature it's best to let us (and everyone else) know what you're working on to avoid any duplication of effort. You can do this by replying to the original Issue for the request.
+
+If you want to contribute an example; go for it! We might not always be able to accept your code, but there's a lot to be learned from trying anyway. If you're new to GitHub we're willing to guide you on that journey.
+
+When contributing a new example or making a change to a library please keep your code style consistent with ours. We try to stick to the pep8 guidelines for Python (https://www.python.org/dev/peps/pep-0008/).
+
+- [Do](#do)
+- [Don't](#dont)
+- [If you're submitting an example](#if-youre-submitting-an-example)
+- [Licensing](#licensing)
+- [Submitting your code](#submitting-your-code)
+
+## Do
+
+* Use pep8 style guidelines
+* Comment your code where necessary
+* Submit only a single example/feature per pull-request
+* Include a description of what your example is expected to do
+* Add details of your example to examples/README.md if it exists
+
+## Don't
+
+* Don't include any license information in your examples- our repositories are MIT licensed
+* Don't try to do too much at once- submit one or two examples at a time, and be receptive to feedback
+* Don't submit multiple variations of the same example, demonstrate one thing concisely
+
+## If you're submitting an example
+
+Try to do one thing, and do it concisely. Keep it simple. Don't mix too many ideas.
+
+The ideal example should:
+
+* Demonstrate one idea, technique or API as concisely as possible in a single Python script
+* *Just work* when you run it. Although sometimes configuration is necessary
+* Be well commented and attempt to teach the user how and why it works
+* Document any required configuration, and how to install API keys, dependencies, etc
+
+If you have a more complex example that uses multiple HATs/pHATs or consists of multiple files then consider submitting it as a project instead- either by creating your own GitHub repository and adding the link to the README.md, or by creating a subfolder in the projects/ directory for your code. For example:
+
+* https://github.com/pimoroni/unicorn-hat-hd/tree/master/projects/unicornpaint
+* https://github.com/pimoroni/phat-beat/tree/master/projects/vlc-radio
+
+And don't forget to shout about your example on our forums/twitter so we can signal-boost you and let everyone know how awesome you are!
+
+## Licensing
+
+When you submit code to our libraries, you implicitly and irrevocably agree to adopt the associated licenses. You should be able to find this in the file named `LICENSE`.
+
+We typically use the MIT license; which permits Commercial Use, Modification, Distribution and Private use of our code, and therefore also your contributions. It also provides good compatibility with other licenses, and is intended to make re-use of our code as painless as possible for all parties, no matter what they might do with it.
+
+You can learn more about the MIT license at Wikipedia: https://en.wikipedia.org/wiki/MIT_License
+
+## Submitting your code
+
+Once you're ready to share your contribution with us you should submit it as a Pull Request.
+
+* Be ready to receive and embrace constructive feedback.
+* Be prepared for rejection; we can't always accept contributions. If you're unsure, ask first!