]> git.bitcoin.ninja Git - youtube-dl/commitdiff
Improve ISSUE_TEMPLATE_tmpl.md
authorSergey M․ <dstftw@gmail.com>
Tue, 29 Mar 2016 16:02:42 +0000 (22:02 +0600)
committerSergey M․ <dstftw@gmail.com>
Tue, 29 Mar 2016 16:02:42 +0000 (22:02 +0600)
.github/ISSUE_TEMPLATE_tmpl.md

index 9bca5b53172310a6c67977941bf6054bf1919b4d..a5e6a4233d88a2b5cdae3d668d2874fb39e6adf0 100644 (file)
@@ -1,22 +1,32 @@
-### Please follow the guide below, provide requested information and put an `x` into all the boxes [ ] relevant to your *issue*.
+## Please follow the guide below
 
-#### :heavy_exclamation_mark: IMPORTANT :heavy_exclamation_mark: Make sure you are using the *latest* version: run `youtube-dl --version` and ensure your version is *%(version)s*. If it's not read [this FAQ entry](https://github.com/rg3/youtube-dl/blob/master/README.md#how-do-i-update-youtube-dl) and update. Issues with outdated version will be rejected.
+- You will be asked some questions and requested to provide some information, please read them **carefully** and answer honestly
+- Put an `x` into all the boxes [ ] relevant to your *issue* (like that [x])
+- Use *Preview* tab to see how your issue will actually look like
+
+---
+
+### Make sure you are using the *latest* version: run `youtube-dl --version` and ensure your version is *%(version)s*. If it's not read [this FAQ entry](https://github.com/rg3/youtube-dl/blob/master/README.md#how-do-i-update-youtube-dl) and update. Issues with outdated version will be rejected.
 - [ ] I've **verified** and **I assure** that I'm running youtube-dl **%(version)s**
 
-#### Before submitting an *issue* make sure you have:
+### Before submitting an *issue* make sure you have:
 - [ ] At least skimmed through [README](https://github.com/rg3/youtube-dl/blob/master/README.md) and **most notably** [FAQ](https://github.com/rg3/youtube-dl#faq) and [BUGS](https://github.com/rg3/youtube-dl#bugs) sections
 - [ ] [Searched](https://github.com/rg3/youtube-dl/search?type=Issues) the bugtracker for similar issues including closed ones
 
-#### What is the purpose of your *issue*?
+### What is the purpose of your *issue*?
 - [ ] Bug report (encountered problems with youtube-dl)
 - [ ] Site support request (request for adding support for a new site)
 - [ ] Feature request (request for a new functionality)
 - [ ] Question
 - [ ] Other
 
-#### The following sections concretize particular purposed issues, you can erase any section not applicable to your *issue*.
+---
+
+### The following sections concretize particular purposed issues, you can erase any section (the contents between triple ---) not applicable to your *issue*
 
-#### :heavy_exclamation_mark: IMPORTANT :heavy_exclamation_mark: If the purpose of this *issue* is a *bug report*, *site support request* or you are not completely sure provide the full verbose output as follows:
+---
+
+### If the purpose of this *issue* is a *bug report*, *site support request* or you are not completely sure provide the full verbose output as follows:
 
 Add `-v` flag to **your command line** you run youtube-dl with, copy the **whole** output and insert it here. It should look similar to one below (replace it with **your** log inserted between triple ```):
 ```
@@ -33,11 +43,16 @@ $ youtube-dl -v <your command line>
 <end of log>
 ```
 
-#### If the purpose of this *issue* is a *site support request* please provide all kinds of example URLs support for which should be included (replace following example URLs by **yours**):
+---
+
+### If the purpose of this *issue* is a *site support request* please provide all kinds of example URLs support for which should be included (replace following example URLs by **yours**):
 - Single video: https://www.youtube.com/watch?v=BaW_jenozKc
 - Single video: https://youtu.be/BaW_jenozKc
 - Playlist: https://www.youtube.com/playlist?list=PL4lCao7KL_QFVb7Iudeipvc2BCavECqzc
 
-#### Description of your *issue*, suggested solution and other information
+---
+
+### Description of your *issue*, suggested solution and other information
 
 Explanation of your *issue* in arbitrary form goes here. Please make sure the [description is worded well enough to be understood](https://github.com/rg3/youtube-dl#is-the-description-of-the-issue-itself-sufficient). Provide as much context and examples as possible.
+If work on your *issue* required an account credentials please provide them or explain how one can obtain them.