diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e69de29bb2..134ef50b99 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -0,0 +1,49 @@ +## Questions about OpenELEC? + +To get your questions answered, please ask in the OpenELEC [Forum] or on IRC: #openelec on freenode.net or [webchat] + +Do not open an issue. + +## Issue Reports + +If you are at all unsure whether it's a bug in OpenELEC or a problem with something +else, post in the OpenELEC [Forum] instead. If it turns out that it is a bug, an issue +can always bee opend later. + +If you are sure that it's a bug in OpenELEC, open a new [issue] and try to +answer the following questions: + +- What did you do? +- What did you expect to happen? +- What happened instead? + +Please also search for similar issues. It's possible somebody has encountered this already. +It is always good to provide the zip file found in the logfiles samba share. + +Make sure to specify which version of OpenELEC you are using. +- OpenELEC version +- OpenELEC build +- OpenELEC arch + +Please don't paste log messages in the issue reports or issue comments use [sprunge.us](http://sprunge.us) instead + +Feature requests are great, but they usually end up lying around the issue +tracker indefinitely. Sending a pull request is a much better way of getting a +particular feature into OpenELEC. + +## Pull Requests + +- **Add tests!** Your patch won't be accepted if it doesn't have tests. + +- **Create topic branches**. Don't ask us to pull from your master branch. + +- **One pull request per feature**. If you want to do more than one thing, send + multiple pull requests. + +- **Send coherent history**. Make sure each individual commit in your pull + request is meaningful. If you had to make multiple intermediate commits while + developing, please squash them before sending them to us. + +[Forum]: http://openelec.tv/forum +[issue]: https://github.com/OpenELEC/OpenELEC.tv/issues +[webchat]: http://openelec.tv/support/chat