Release 2024.12.13
[yt-dlp.git] / .github / ISSUE_TEMPLATE / 5_feature_request.yml
blob765de86a29d4fe2b41bf448863e7726eb8e2b594
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-nightly-builds [1a176d874] (win_exe)
56         [debug] Python 3.10.11 (CPython AMD64 64bit) - Windows-10-10.0.20348-SP0 (OpenSSL 1.1.1t  7 Feb 2023)
57         [debug] exe versions: ffmpeg 7.0.2 (setts), ffprobe 7.0.2
58         [debug] Optional libraries: Cryptodome-3.21.0, brotli-1.1.0, certifi-2024.08.30, curl_cffi-0.5.10, mutagen-1.47.0, requests-2.32.3, sqlite3-3.40.1, urllib3-2.2.3, websockets-13.1
59         [debug] Proxy map: {}
60         [debug] Request Handlers: urllib, requests, websockets, curl_cffi
61         [debug] Loaded 1838 extractors
62         [debug] Fetching release info: https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest
63         Latest version: nightly@... from yt-dlp/yt-dlp-nightly-builds
64         yt-dlp is up to date (nightly@... from yt-dlp/yt-dlp-nightly-builds)
65         [youtube] Extracting URL: https://www.youtube.com/watch?v=BaW_jenozKc
66         <more lines>
67       render: shell
68   - type: markdown
69     attributes:
70       value: |
71         > [!CAUTION]
72         > ### GitHub is experiencing a high volume of malicious spam comments.
73         > ### If you receive any replies asking you download a file, do NOT follow the download links!
74         >
75         > Note that this issue may be temporarily locked as an anti-spam measure after it is opened.