From 9e2c41230c3b962fc324d294de944e3f0ede81b9 Mon Sep 17 00:00:00 2001 From: Rafi Khan Date: Sun, 21 Feb 2016 00:13:00 -0600 Subject: [PATCH] added contribution guidelines --- Contributing.md | 11 +++++++++++ README.md | 2 ++ 2 files changed, 13 insertions(+) create mode 100644 Contributing.md diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 0000000..81df234 --- /dev/null +++ b/Contributing.md @@ -0,0 +1,11 @@ +# Contribution Guidlines + +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 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 + +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! \ No newline at end of file diff --git a/README.md b/README.md index 94068a9..03fb6d2 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,8 @@ If you want to contribute to this project: - Tell other people about this library - Contribute new protocols +Check [here](Contributing.md) for some guidelines. + ## Contact The only way to contact me at the moment is by email: zetoslab@gmail.com I am not currently monitoring any PRs or Issues due to other issues but will respond to all emails. If anyone wants contributor access, feel free to email me. Or if you find any Issues/PRs to be of importance that my attention is needed please email me.