added ISSUE_TEMPLATE

This commit is contained in:
Rafi Khan 2016-02-21 00:48:41 -06:00
parent cb01593db0
commit 17628525af
2 changed files with 22 additions and 1 deletions

View File

@ -6,6 +6,6 @@ The following are some guidelines to observe when creating issues or PRs:
- Be friendly; it is important that we can all enjoy a safe space as we are all working on the same project and it is okay for people to have different ideas
- [Use code blocks](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code); it helps us help you when we can read your code! On that note also refrain from pasting more than 30 lines of code in a post, instead [create a gist](https://gist.github.com/) if you need to share large snippets
- Use reasonable titles; refrain from using overly long or capitalized titles as they are usually annoying and do little to encourage others to help :smile:
- Be detailed; refrain from mentioning code problems without sharing your source code and always give information regarding your board and version of the library
- Be detailed; refrain from mentioning code problems without sharing your source code and always give information regarding your board and version of the library
If there is any need to contact me then you can find my email on the README, I do not mind responding to emails but it would be in your own interests to create issues if you need help with the library as responses would be from a larger community with greater knowledge!

21
ISSUE_TEMPLATE.md Normal file
View File

@ -0,0 +1,21 @@
**Board:** ARDUINO UNO
**Library Version:** 2.1.0
**Protocol:** Sony (if any)
**Code Block:**
```c
#include <IRremote.h>
.....
```
Use [a gist](gist.github.com) if the code exceeds 30 lines
**checklist:**
- [] The latest [release](https://github.com/z3t0/Arduino-IRremote/releases/latest) is used
- [] Any code referenced is provided
- [] The title of the issue is helpful and relevant
The above is a short template allowing you to make detailed issues!