Skip to content

Commit 1762852

Browse files
committed
added ISSUE_TEMPLATE
1 parent cb01593 commit 1762852

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

Contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ The following are some guidelines to observe when creating issues or PRs:
66
- 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
77
- [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
88
- 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:
9-
- Be detailed; refrain from mentioning code problems without sharing your source code and always give information regarding your board and version of the library
9+
- Be detailed; refrain from mentioning code problems without sharing your source code and always give information regarding your board and version of the library
1010

1111
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!

ISSUE_TEMPLATE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
**Board:** ARDUINO UNO
2+
**Library Version:** 2.1.0
3+
**Protocol:** Sony (if any)
4+
5+
**Code Block:**
6+
```c
7+
8+
#include <IRremote.h>
9+
10+
.....
11+
12+
```
13+
14+
Use [a gist](gist.github.com) if the code exceeds 30 lines
15+
16+
**checklist:**
17+
- [] The latest [release](https://github.com/z3t0/Arduino-IRremote/releases/latest) is used
18+
- [] Any code referenced is provided
19+
- [] The title of the issue is helpful and relevant
20+
21+
The above is a short template allowing you to make detailed issues!

0 commit comments

Comments
 (0)