]> jfr.im git - yt-dlp.git/blame - .github/ISSUE_TEMPLATE_tmpl.md
Start moving to ytdl-org
[yt-dlp.git] / .github / ISSUE_TEMPLATE_tmpl.md
CommitLineData
0b7bfc94 1## Please follow the guide below
3842a3e6 2
0b7bfc94 3- You will be asked some questions and requested to provide some information, please read them **carefully** and answer honestly
31509766 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
0b7bfc94
S
6
7---
8
067aa17e 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/ytdl-org/youtube-dl/blob/master/README.md#how-do-i-update-youtube-dl) and update. Issues with outdated version will be rejected.
3842a3e6
S
10- [ ] I've **verified** and **I assure** that I'm running youtube-dl **%(version)s**
11
0b7bfc94 12### Before submitting an *issue* make sure you have:
067aa17e
S
13- [ ] At least skimmed through the [README](https://github.com/ytdl-org/youtube-dl/blob/master/README.md), **most notably** the [FAQ](https://github.com/ytdl-org/youtube-dl#faq) and [BUGS](https://github.com/ytdl-org/youtube-dl#bugs) sections
14- [ ] [Searched](https://github.com/ytdl-org/youtube-dl/search?type=Issues) the bugtracker for similar issues including closed ones
69a934e9 15- [ ] Checked that provided video/audio/playlist URLs (if any) are alive and playable in a browser
3842a3e6 16
0b7bfc94 17### What is the purpose of your *issue*?
3842a3e6
S
18- [ ] Bug report (encountered problems with youtube-dl)
19- [ ] Site support request (request for adding support for a new site)
20- [ ] Feature request (request for a new functionality)
21- [ ] Question
22- [ ] Other
23
0b7bfc94
S
24---
25
26### The following sections concretize particular purposed issues, you can erase any section (the contents between triple ---) not applicable to your *issue*
3842a3e6 27
0b7bfc94
S
28---
29
30### 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:
3842a3e6 31
31509766 32Add 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 ```):
33
3842a3e6 34```
3842a3e6
S
35[debug] System config: []
36[debug] User config: []
37[debug] Command-line args: [u'-v', u'http://www.youtube.com/watch?v=BaW_jenozKcj']
38[debug] Encodings: locale cp1251, fs mbcs, out cp866, pref cp1251
39[debug] youtube-dl version %(version)s
40[debug] Python version 2.7.11 - Windows-2003Server-5.2.3790-SP2
41[debug] exe versions: ffmpeg N-75573-g1d0487f, ffprobe N-75573-g1d0487f, rtmpdump 2.4
42[debug] Proxy map: {}
43...
44<end of log>
45```
46
0b7bfc94
S
47---
48
49### 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**):
3842a3e6
S
50- Single video: https://www.youtube.com/watch?v=BaW_jenozKc
51- Single video: https://youtu.be/BaW_jenozKc
52- Playlist: https://www.youtube.com/playlist?list=PL4lCao7KL_QFVb7Iudeipvc2BCavECqzc
53
067aa17e 54Note that **youtube-dl does not support sites dedicated to [copyright infringement](https://github.com/ytdl-org/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.
e5e19379 55
0b7bfc94
S
56---
57
58### Description of your *issue*, suggested solution and other information
3842a3e6 59
067aa17e 60Explanation of your *issue* in arbitrary form goes here. Please make sure the [description is worded well enough to be understood](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient). Provide as much context and examples as possible.
fcba157e 61If work on your *issue* requires account credentials please provide them or explain how one can obtain them.