From 36bd357f9f939cf5c20dcfc32300e1a732c04175 Mon Sep 17 00:00:00 2001 From: friday Date: Fri, 27 Jul 2018 18:21:08 +0200 Subject: [PATCH] Updated Writing helpful issue descriptions (markdown) --- Writing-helpful-issue-descriptions.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/Writing-helpful-issue-descriptions.md b/Writing-helpful-issue-descriptions.md index 639a330..2fa71d4 100644 --- a/Writing-helpful-issue-descriptions.md +++ b/Writing-helpful-issue-descriptions.md @@ -2,9 +2,14 @@ When you're asking for help or reporting an issue, someone else has to take thei *If the problem happens on the demo at [plyr.io](https://plyr.io/), skip to [describing the problem](#describe-the-problem).* -### Check the console for errors +### Check for errors -Before going further, start by checking the developer console for errors. If you don't know how to do this, use a search engine to find it (it varies per browser and operating system). +Before going further, verify that +* You are using the latest version of Plyr. +* You are following the documentation correctly (https://github.com/sampotts/plyr/) +* You aren't getting any errors in the developer console. + +If you don't know how to use the developer console. Please use a search engine to find it (it varies per browser and operating system). If you have errors. Check where in the code they happened. If it's your code, then it's probably your mistake too and not something you should be asking us, while if it's Plyr code it's likely a Plyr bug (it's not always this simple though). @@ -12,6 +17,8 @@ If you have errors. Check where in the code they happened. If it's your code, th Remove everything you don't need to demonstrate the issue. Keep *only* the HTML and CSS needed to show the problem, *only* the javascript code related to the problem, and no external frameworks or libraries, unless the issue *only* happen with the specific library or framework. +This also means you should remove Plyr and use native HTML5 video when applicable, to verify this really is a Plyr issue. + If you don't know how the problem is happening, remove one isolated part at the time while testing if the problem remains. Doing this often helps you find out if it was a mistake that you made, or external factor that's not related to Plyr. If it's neither of these it'll help you get closer to the issue. Libraries and frameworks are just code, so most of the time you have an issue with a library or framework breaking Plyr's behavior it's better to demonstrate it by writing code that creates the same problem that the library or framework did. If it's the other way (Plyr breaking a library or framework) it may be a good idea to include the library or framework in the replication demo, in addition to describing the issue and documenting the code. You should do this without making the assumption that the reader has used the library or framework before.