zhangyuqing
/
Arduino-IRremote
mirror of https://github.com/Arduino-IRremote/Arduino-IRremote.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation

This commit is contained in:
Armin 2020-06-08 15:02:25 +02:00
parent c6e9013528
commit ffe19fa719
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Contributing.md
View File

@ -1,11 +1,12 @@
# Contribution Guidlines
# Contribution Guidelines
This library is the culmination of the expertise of many members of the open source community who have dedicated their time and hard work. The best way to ask for help or propose a new idea is to [create a new issue](https://github.com/z3t0/Arduino-IRremote/issues/new) while creating a Pull Request with your code changes allows you to share your own innovations with the rest of the community.
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 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
- Choose the right Pull Request target; if you only have **minor changes or adding a new protocol**, choose **master** as target for your Pull Request. If have a change **adressing more general aspects** of this library or think, that the PR should be **discussed and reviewed**, choose the **dev** branch as target for your Pull Request like described [here](https://guides.github.com/introduction/flow/).
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!