Release 2024.10.22
[yt-dlp.git] / .github / ISSUE_TEMPLATE / 5_feature_request.yml
blobc600a9dcb6ae23455da6b5329742e97a75e522bc
1 name: Feature request
2 description: Request a new functionality unrelated to any particular site or extractor
3 labels: [triage, enhancement]
4 body:
5   - type: checkboxes
6     attributes:
7       label: DO NOT REMOVE OR SKIP THE ISSUE TEMPLATE
8       description: Fill all fields even if you think it is irrelevant for the issue
9       options:
10         - label: I understand that I will be **blocked** if I *intentionally* remove or skip any mandatory\* field
11           required: true
12   - type: checkboxes
13     id: checklist
14     attributes:
15       label: Checklist
16       description: |
17         Carefully read and work through this check list in order to prevent the most common mistakes and misuse of yt-dlp:
18       options:
19         - label: I'm requesting a feature unrelated to a specific site
20           required: true
21         - label: I've looked through the [README](https://github.com/yt-dlp/yt-dlp#readme)
22           required: true
23         - label: I've verified that I have **updated yt-dlp to nightly or master** ([update instructions](https://github.com/yt-dlp/yt-dlp#update-channels))
24           required: true
25         - label: I've searched [known issues](https://github.com/yt-dlp/yt-dlp/issues/3766) and the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues **including closed ones**. DO NOT post duplicates
26           required: true
27         - label: I've read the [guidelines for opening an issue](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue)
28           required: true
29   - type: textarea
30     id: description
31     attributes:
32       label: Provide a description that is worded well enough to be understood
33       description: See [is-the-description-of-the-issue-itself-sufficient](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#is-the-description-of-the-issue-itself-sufficient)
34       placeholder: Provide any additional information, any suggested solutions, and as much context and examples as possible
35     validations:
36       required: true
37   - type: checkboxes
38     id: verbose
39     attributes:
40       label: Provide verbose output that clearly demonstrates the problem
41       options:
42         - label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU <your command line>`)
43         - label: "If using API, add `'verbose': True` to `YoutubeDL` params instead"
44           required: false
45         - label: Copy the WHOLE output (starting with `[debug] Command-line config`) and insert it below
46   - type: textarea
47     id: log
48     attributes:
49       label: Complete Verbose Output
50       description: |
51         It should start like this:
52       placeholder: |
53         [debug] Command-line config: ['-vU', 'https://www.youtube.com/watch?v=BaW_jenozKc']
54         [debug] Encodings: locale cp65001, fs utf-8, pref cp65001, out utf-8, error utf-8, screen utf-8
55         [debug] yt-dlp version nightly@... from yt-dlp/yt-dlp [b634ba742] (win_exe)
56         [debug] Python 3.8.10 (CPython 64bit) - Windows-10-10.0.22000-SP0
57         [debug] exe versions: ffmpeg N-106550-g072101bd52-20220410 (fdk,setts), ffprobe N-106624-g391ce570c8-20220415, phantomjs 2.1.1
58         [debug] Optional libraries: Cryptodome-3.15.0, brotli-1.0.9, certifi-2022.06.15, mutagen-1.45.1, sqlite3-2.6.0, websockets-10.3
59         [debug] Proxy map: {}
60         [debug] Request Handlers: urllib, requests
61         [debug] Loaded 1893 extractors
62         [debug] Fetching release info: https://api.github.com/repos/yt-dlp/yt-dlp-nightly-builds/releases/latest
63         yt-dlp is up to date (nightly@... from yt-dlp/yt-dlp-nightly-builds)
64         [youtube] Extracting URL: https://www.youtube.com/watch?v=BaW_jenozKc
65         <more lines>
66       render: shell
67   - type: markdown
68     attributes:
69       value: |
70         > [!CAUTION]
71         > ### GitHub is experiencing a high volume of malicious spam comments.
72         > ### If you receive any replies asking you download a file, do NOT follow the download links!
73         >
74         > Note that this issue may be temporarily locked as an anti-spam measure after it is opened.