summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE_tmpl.md
blob: 26f61d3b43e85fb3b45ac09a7dd9be8c9c2e9b26 (plain)
    1 ## Please follow the guide below
    2 
    3 - You will be asked some questions and requested to provide some information, please read them **carefully** and answer honestly
    4 - Put an `x` into all the boxes [ ] relevant to your *issue* (like this: `[x]`)
    5 - Use the *Preview* tab to see what your issue will actually look like
    6 
    7 ---
    8 
    9 ### 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.
   10 - [ ] I've **verified** and **I assure** that I'm running youtube-dl **%(version)s**
   11 
   12 ### Before submitting an *issue* make sure you have:
   13 - [ ] At least skimmed through the [README](https://github.com/rg3/youtube-dl/blob/master/README.md), **most notably** the [FAQ](https://github.com/rg3/youtube-dl#faq) and [BUGS](https://github.com/rg3/youtube-dl#bugs) sections
   14 - [ ] [Searched](https://github.com/rg3/youtube-dl/search?type=Issues) the bugtracker for similar issues including closed ones
   15 
   16 ### What is the purpose of your *issue*?
   17 - [ ] Bug report (encountered problems with youtube-dl)
   18 - [ ] Site support request (request for adding support for a new site)
   19 - [ ] Feature request (request for a new functionality)
   20 - [ ] Question
   21 - [ ] Other
   22 
   23 ---
   24 
   25 ### The following sections concretize particular purposed issues, you can erase any section (the contents between triple ---) not applicable to your *issue*
   26 
   27 ---
   28 
   29 ### 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:
   30 
   31 Add the `-v` flag to **your command line** you run youtube-dl with (`youtube-dl -v <your command line>`), copy the **whole** output and insert it here. It should look similar to one below (replace it with **your** log inserted between triple ```):
   32 
   33 ```
   34 [debug] System config: []
   35 [debug] User config: []
   36 [debug] Command-line args: [u'-v', u'http://www.youtube.com/watch?v=BaW_jenozKcj']
   37 [debug] Encodings: locale cp1251, fs mbcs, out cp866, pref cp1251
   38 [debug] youtube-dl version %(version)s
   39 [debug] Python version 2.7.11 - Windows-2003Server-5.2.3790-SP2
   40 [debug] exe versions: ffmpeg N-75573-g1d0487f, ffprobe N-75573-g1d0487f, rtmpdump 2.4
   41 [debug] Proxy map: {}
   42 ...
   43 <end of log>
   44 ```
   45 
   46 ---
   47 
   48 ### 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**):
   49 - Single video: https://www.youtube.com/watch?v=BaW_jenozKc
   50 - Single video: https://youtu.be/BaW_jenozKc
   51 - Playlist: https://www.youtube.com/playlist?list=PL4lCao7KL_QFVb7Iudeipvc2BCavECqzc
   52 
   53 Note that **youtube-dl does not support sites dedicated to [copyright infringement](https://github.com/rg3/youtube-dl#can-you-add-support-for-this-anime-video-site-or-site-which-shows-current-movies-for-free)**. In order for site support request to be accepted all provided example URLs should not violate any copyrights.
   54 
   55 ---
   56 
   57 ### Description of your *issue*, suggested solution and other information
   58 
   59 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.
   60 If work on your *issue* requires account credentials please provide them or explain how one can obtain them.

Generated by cgit