From f9f478e10014cc22433b9fc5f232f56e2a586bf5 Mon Sep 17 00:00:00 2001 From: JonnyWong16 Date: Sat, 20 Feb 2016 20:47:33 -0800 Subject: [PATCH] Update CONTRIBUTING.md with info about issue reporting and feature requests --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++---- 1 file changed, 35 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 146b1cfe..96536260 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,10 +3,41 @@ ## Issues In case you read this because you are posting an issue, please take a minute and conside the things below. The issue tracker is not a support forum. It is primarily intended to submit bugs, improvements or feature requests. However, we are glad to help you, and make sure the problem is not caused by PlexPy, but don't expect step-by-step answers. -* Use the search function. Chances are that your problem is already discussed. Do not append to (closed) issues if your problem does not fit the discussion. -* Visit the [Troubleshooting](../../wiki/TroubleShooting) wiki first. -* Use [proper formatting](https://help.github.com/articles/github-flavored-markdown/). Paste your logs in code blocks. -* Close your issue if you resolved it. +##### Many issues can simply be solved by: + +- Making sure you update to the latest version. +- Turning your device off and on again. +- Analyzing your logs, you just might find the solution yourself! +- Using the **search** function to see if this issue has already been reported/solved. +- Checking the [Wiki](https://github.com/drzoidberg33/plexpy/wiki) for +[ [Installation] ](https://github.com/drzoidberg33/plexpy/wiki/Installation) and +[ [FAQs] ](https://github.com/drzoidberg33/plexpy/wiki/Frequently-Asked-Questions-(FAQ)). +- For basic questions try asking on [Gitter](https://gitter.im/drzoidberg33/plexpy) or the [Plex Forums](https://forums.plex.tv/discussion/169591/plexpy-another-plex-monitoring-program) first before opening an issue. + +##### If nothing has worked: + +1. Open a new issue on the GitHub [issue tracker](http://github.com/drzoidberg33/plexpy/issues). +2. Provide a clear title to easily help identify your problem. +3. Use proper [markdown syntax](https://help.github.com/articles/github-flavored-markdown) to structure your post (i.e. code/log in code blocks). +4. Make sure you provide the following information: + - [ ] Branch + - [ ] Version/Commit hash + - [ ] Your operating system and python version + - [ ] What you did? + - [ ] What happened? + - [ ] What you expected? + - [ ] How can we reproduce your issue? + - [ ] What are your (relevant) settings? + - [ ] Include a link to your **FULL** (not just a few lines!) log file that has the error. Please use [Gist](http://gist.github.com) or [Pastebin](http://pastebin.com/). +5. Close your issue when it's solved! If you found the solution yourself please comment so that others benefit from it. + +## Feature Requests + +1. Search for similar existing 'issues', feature requests can be recognized by the blue `enhancement` label. +2. If a similar request exists, post a comment (+1, or add a new idea to the existing request). +3. If no similar requests exist, you can create a new one. +4. Provide a clear title to easily identify the feature request. +5. Tag your feature request with `[Feature Request]` so it can be identified easily. ## Pull Requests If you think you can contribute code to the PlexPy repository, do not hesitate to submit a pull request.