From ca9f1df25346816baacb13e875f3873c47be86e2 Mon Sep 17 00:00:00 2001 From: pukkandan Date: Thu, 30 Jun 2022 04:06:27 +0530 Subject: [PATCH] [docs] Improve issue templates --- .github/ISSUE_TEMPLATE/1_broken_site.yml | 48 ++++++++++------- .../ISSUE_TEMPLATE/2_site_support_request.yml | 47 +++++++++------- .../ISSUE_TEMPLATE/3_site_feature_request.yml | 49 +++++++++-------- .github/ISSUE_TEMPLATE/4_bug_report.yml | 45 +++++++++------- .github/ISSUE_TEMPLATE/5_feature_request.yml | 45 +++++++++------- .github/ISSUE_TEMPLATE/6_question.yml | 53 +++++++++++-------- .github/ISSUE_TEMPLATE_tmpl/1_broken_site.yml | 38 +++---------- .../2_site_support_request.yml | 37 +++---------- .../3_site_feature_request.yml | 39 +++----------- .github/ISSUE_TEMPLATE_tmpl/4_bug_report.yml | 35 ++---------- .../ISSUE_TEMPLATE_tmpl/5_feature_request.yml | 33 ++---------- .github/ISSUE_TEMPLATE_tmpl/6_question.yml | 41 ++++---------- .github/PULL_REQUEST_TEMPLATE.md | 19 +++++-- devscripts/make_issue_template.py | 47 ++++++++++++++-- 14 files changed, 267 insertions(+), 309 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1_broken_site.yml b/.github/ISSUE_TEMPLATE/1_broken_site.yml index c1da044ce3..b8e3988160 100644 --- a/.github/ISSUE_TEMPLATE/1_broken_site.yml +++ b/.github/ISSUE_TEMPLATE/1_broken_site.yml @@ -17,7 +17,7 @@ body: required: true - label: I've checked that all URLs and arguments with special characters are [properly quoted or escaped](https://github.com/ytdl-org/youtube-dl#video-url-contains-an-ampersand-and-im-getting-some-strange-output-1-2839-or-v-is-not-recognized-as-an-internal-or-external-command) required: true - - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues including closed ones. DO NOT post duplicates + - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues **including closed ones**. DO NOT post duplicates required: true - label: I've read the [guidelines for opening an issue](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue) required: true @@ -26,36 +26,44 @@ body: id: region attributes: label: Region - description: "Enter the region the site is accessible from" - placeholder: "India" + description: Enter the country/region that the site is accessible from + placeholder: India - type: textarea id: description attributes: - label: Description - description: | - Provide an explanation of your issue in an arbitrary form. - Provide any additional information, any suggested solutions, and as much context and examples as possible - placeholder: WRITE DESCRIPTION HERE + label: Provide a description that is worded well enough to be understood + description: See [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient) + placeholder: Provide any additional information, any suggested solutions, and as much context and examples as possible validations: required: true + - type: checkboxes + id: verbose + attributes: + label: Provide verbose output that clearly demonstrates the problem + options: + - label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU `) + required: true + - label: Copy the WHOLE output (starting with `[debug] Command-line config`) and insert it below + required: true - type: textarea id: log attributes: - label: Verbose log + label: Complete Verbose Output description: | - Provide the complete verbose output of yt-dlp **that clearly demonstrates the problem**. - Add the `-vU` flag to your command line you run yt-dlp with (`yt-dlp -vU `), copy the WHOLE output and insert it below. - It should look similar to this: + It should start like this: placeholder: | - [debug] Command-line config: ['-vU', 'http://www.youtube.com/watch?v=BaW_jenozKc'] - [debug] Portable config file: yt-dlp.conf - [debug] Portable config: ['-i'] - [debug] Encodings: locale cp1252, fs utf-8, stdout utf-8, stderr utf-8, pref cp1252 - [debug] yt-dlp version 2022.06.29 (exe) - [debug] Python version 3.8.8 (CPython 64bit) - Windows-10-10.0.19041-SP0 - [debug] exe versions: ffmpeg 3.0.1, ffprobe 3.0.1 - [debug] Optional libraries: Cryptodome, keyring, mutagen, sqlite, websockets + [debug] Command-line config: ['-vU', 'test:youtube'] + [debug] Portable config "yt-dlp.conf": ['-i'] + [debug] Encodings: locale cp65001, fs utf-8, pref cp65001, out utf-8, error utf-8, screen utf-8 + [debug] yt-dlp version 2022.06.29 [9d339c4] (win32_exe) + [debug] Python 3.8.10 (CPython 64bit) - Windows-10-10.0.22000-SP0 + [debug] Checking exe version: ffmpeg -bsfs + [debug] Checking exe version: ffprobe -bsfs + [debug] exe versions: ffmpeg N-106550-g072101bd52-20220410 (fdk,setts), ffprobe N-106624-g391ce570c8-20220415, phantomjs 2.1.1 + [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 [debug] Proxy map: {} + [debug] Fetching release info: https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest + Latest version: 2022.06.29, Current version: 2022.06.29 yt-dlp is up to date (2022.06.29) render: shell diff --git a/.github/ISSUE_TEMPLATE/2_site_support_request.yml b/.github/ISSUE_TEMPLATE/2_site_support_request.yml index d72b4538b4..5aeb0e326f 100644 --- a/.github/ISSUE_TEMPLATE/2_site_support_request.yml +++ b/.github/ISSUE_TEMPLATE/2_site_support_request.yml @@ -17,7 +17,7 @@ body: required: true - label: I've checked that none of provided URLs [violate any copyrights](https://github.com/ytdl-org/youtube-dl#can-you-add-support-for-this-anime-video-site-or-site-which-shows-current-movies-for-free) or contain any [DRM](https://en.wikipedia.org/wiki/Digital_rights_management) to the best of my knowledge required: true - - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues including closed ones. DO NOT post duplicates + - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues **including closed ones**. DO NOT post duplicates required: true - label: I've read the [guidelines for opening an issue](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue) required: true @@ -26,8 +26,8 @@ body: id: region attributes: label: Region - description: "Enter the region the site is accessible from" - placeholder: "India" + description: Enter the country/region that the site is accessible from + placeholder: India - type: textarea id: example-urls attributes: @@ -43,30 +43,39 @@ body: - type: textarea id: description attributes: - label: Description - description: | - Provide any additional information - placeholder: WRITE DESCRIPTION HERE + label: Provide a description that is worded well enough to be understood + description: See [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient) + placeholder: Provide any additional information, any suggested solutions, and as much context and examples as possible validations: required: true + - type: checkboxes + id: verbose + attributes: + label: Provide verbose output that clearly demonstrates the problem + options: + - label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU `) + required: true + - label: Copy the WHOLE output (starting with `[debug] Command-line config`) and insert it below + required: true - type: textarea id: log attributes: - label: Verbose log + label: Complete Verbose Output description: | - Provide the complete verbose output **using one of the example URLs provided above**. - Add the `-vU` flag to your command line you run yt-dlp with (`yt-dlp -vU `), copy the WHOLE output and insert it below. - It should look similar to this: + It should start like this: placeholder: | - [debug] Command-line config: ['-vU', 'http://www.youtube.com/watch?v=BaW_jenozKc'] - [debug] Portable config file: yt-dlp.conf - [debug] Portable config: ['-i'] - [debug] Encodings: locale cp1252, fs utf-8, stdout utf-8, stderr utf-8, pref cp1252 - [debug] yt-dlp version 2022.06.29 (exe) - [debug] Python version 3.8.8 (CPython 64bit) - Windows-10-10.0.19041-SP0 - [debug] exe versions: ffmpeg 3.0.1, ffprobe 3.0.1 - [debug] Optional libraries: Cryptodome, keyring, mutagen, sqlite, websockets + [debug] Command-line config: ['-vU', 'test:youtube'] + [debug] Portable config "yt-dlp.conf": ['-i'] + [debug] Encodings: locale cp65001, fs utf-8, pref cp65001, out utf-8, error utf-8, screen utf-8 + [debug] yt-dlp version 2022.06.29 [9d339c4] (win32_exe) + [debug] Python 3.8.10 (CPython 64bit) - Windows-10-10.0.22000-SP0 + [debug] Checking exe version: ffmpeg -bsfs + [debug] Checking exe version: ffprobe -bsfs + [debug] exe versions: ffmpeg N-106550-g072101bd52-20220410 (fdk,setts), ffprobe N-106624-g391ce570c8-20220415, phantomjs 2.1.1 + [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 [debug] Proxy map: {} + [debug] Fetching release info: https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest + Latest version: 2022.06.29, Current version: 2022.06.29 yt-dlp is up to date (2022.06.29) render: shell diff --git a/.github/ISSUE_TEMPLATE/3_site_feature_request.yml b/.github/ISSUE_TEMPLATE/3_site_feature_request.yml index d31499a54a..b34abe6675 100644 --- a/.github/ISSUE_TEMPLATE/3_site_feature_request.yml +++ b/.github/ISSUE_TEMPLATE/3_site_feature_request.yml @@ -15,7 +15,7 @@ body: required: true - label: I've checked that all provided URLs are playable in a browser with the same IP and same login details required: true - - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues including closed ones. DO NOT post duplicates + - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues **including closed ones**. DO NOT post duplicates required: true - label: I've read the [guidelines for opening an issue](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue) required: true @@ -24,8 +24,8 @@ body: id: region attributes: label: Region - description: "Enter the region the site is accessible from" - placeholder: "India" + description: Enter the country/region that the site is accessible from + placeholder: India - type: textarea id: example-urls attributes: @@ -39,32 +39,39 @@ body: - type: textarea id: description attributes: - label: Description - description: | - Provide an explanation of your site feature request in an arbitrary form. - Please make sure the description is worded well enough to be understood, see [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient). - Provide any additional information, any suggested solutions, and as much context and examples as possible - placeholder: WRITE DESCRIPTION HERE + label: Provide a description that is worded well enough to be understood + description: See [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient) + placeholder: Provide any additional information, any suggested solutions, and as much context and examples as possible validations: required: true + - type: checkboxes + id: verbose + attributes: + label: Provide verbose output that clearly demonstrates the problem + options: + - label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU `) + required: true + - label: Copy the WHOLE output (starting with `[debug] Command-line config`) and insert it below + required: true - type: textarea id: log attributes: - label: Verbose log + label: Complete Verbose Output description: | - Provide the complete verbose output of yt-dlp that demonstrates the need for the enhancement. - Add the `-vU` flag to your command line you run yt-dlp with (`yt-dlp -vU `), copy the WHOLE output and insert it below. - It should look similar to this: + It should start like this: placeholder: | - [debug] Command-line config: ['-vU', 'http://www.youtube.com/watch?v=BaW_jenozKc'] - [debug] Portable config file: yt-dlp.conf - [debug] Portable config: ['-i'] - [debug] Encodings: locale cp1252, fs utf-8, stdout utf-8, stderr utf-8, pref cp1252 - [debug] yt-dlp version 2022.06.29 (exe) - [debug] Python version 3.8.8 (CPython 64bit) - Windows-10-10.0.19041-SP0 - [debug] exe versions: ffmpeg 3.0.1, ffprobe 3.0.1 - [debug] Optional libraries: Cryptodome, keyring, mutagen, sqlite, websockets + [debug] Command-line config: ['-vU', 'test:youtube'] + [debug] Portable config "yt-dlp.conf": ['-i'] + [debug] Encodings: locale cp65001, fs utf-8, pref cp65001, out utf-8, error utf-8, screen utf-8 + [debug] yt-dlp version 2022.06.29 [9d339c4] (win32_exe) + [debug] Python 3.8.10 (CPython 64bit) - Windows-10-10.0.22000-SP0 + [debug] Checking exe version: ffmpeg -bsfs + [debug] Checking exe version: ffprobe -bsfs + [debug] exe versions: ffmpeg N-106550-g072101bd52-20220410 (fdk,setts), ffprobe N-106624-g391ce570c8-20220415, phantomjs 2.1.1 + [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 [debug] Proxy map: {} + [debug] Fetching release info: https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest + Latest version: 2022.06.29, Current version: 2022.06.29 yt-dlp is up to date (2022.06.29) render: shell diff --git a/.github/ISSUE_TEMPLATE/4_bug_report.yml b/.github/ISSUE_TEMPLATE/4_bug_report.yml index 3f79c03cdc..1ab854bb94 100644 --- a/.github/ISSUE_TEMPLATE/4_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/4_bug_report.yml @@ -17,39 +17,46 @@ body: required: true - label: I've checked that all URLs and arguments with special characters are [properly quoted or escaped](https://github.com/ytdl-org/youtube-dl#video-url-contains-an-ampersand-and-im-getting-some-strange-output-1-2839-or-v-is-not-recognized-as-an-internal-or-external-command) required: true - - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues including closed ones. DO NOT post duplicates + - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues **including closed ones**. DO NOT post duplicates required: true - label: I've read the [guidelines for opening an issue](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue) required: true - type: textarea id: description attributes: - label: Description - description: | - Provide an explanation of your issue in an arbitrary form. - Please make sure the description is worded well enough to be understood, see [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient). - Provide any additional information, any suggested solutions, and as much context and examples as possible - placeholder: WRITE DESCRIPTION HERE + label: Provide a description that is worded well enough to be understood + description: See [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient) + placeholder: Provide any additional information, any suggested solutions, and as much context and examples as possible validations: required: true + - type: checkboxes + id: verbose + attributes: + label: Provide verbose output that clearly demonstrates the problem + options: + - label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU `) + required: true + - label: Copy the WHOLE output (starting with `[debug] Command-line config`) and insert it below + required: true - type: textarea id: log attributes: - label: Verbose log + label: Complete Verbose Output description: | - Provide the complete verbose output of yt-dlp **that clearly demonstrates the problem**. - Add the `-vU` flag to **your** command line you run yt-dlp with (`yt-dlp -vU `), copy the WHOLE output and insert it below. - It should look similar to this: + It should start like this: placeholder: | - [debug] Command-line config: ['-vU', 'http://www.youtube.com/watch?v=BaW_jenozKc'] - [debug] Portable config file: yt-dlp.conf - [debug] Portable config: ['-i'] - [debug] Encodings: locale cp1252, fs utf-8, stdout utf-8, stderr utf-8, pref cp1252 - [debug] yt-dlp version 2022.06.29 (exe) - [debug] Python version 3.8.8 (CPython 64bit) - Windows-10-10.0.19041-SP0 - [debug] exe versions: ffmpeg 3.0.1, ffprobe 3.0.1 - [debug] Optional libraries: Cryptodome, keyring, mutagen, sqlite, websockets + [debug] Command-line config: ['-vU', 'test:youtube'] + [debug] Portable config "yt-dlp.conf": ['-i'] + [debug] Encodings: locale cp65001, fs utf-8, pref cp65001, out utf-8, error utf-8, screen utf-8 + [debug] yt-dlp version 2022.06.29 [9d339c4] (win32_exe) + [debug] Python 3.8.10 (CPython 64bit) - Windows-10-10.0.22000-SP0 + [debug] Checking exe version: ffmpeg -bsfs + [debug] Checking exe version: ffprobe -bsfs + [debug] exe versions: ffmpeg N-106550-g072101bd52-20220410 (fdk,setts), ffprobe N-106624-g391ce570c8-20220415, phantomjs 2.1.1 + [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 [debug] Proxy map: {} + [debug] Fetching release info: https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest + Latest version: 2022.06.29, Current version: 2022.06.29 yt-dlp is up to date (2022.06.29) render: shell diff --git a/.github/ISSUE_TEMPLATE/5_feature_request.yml b/.github/ISSUE_TEMPLATE/5_feature_request.yml index bb75944589..72551022b5 100644 --- a/.github/ISSUE_TEMPLATE/5_feature_request.yml +++ b/.github/ISSUE_TEMPLATE/5_feature_request.yml @@ -15,39 +15,44 @@ body: required: true - label: I've verified that I'm running yt-dlp version **2022.06.29** ([update instructions](https://github.com/yt-dlp/yt-dlp#update)) or later (specify commit) required: true - - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues including closed ones. DO NOT post duplicates + - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues **including closed ones**. DO NOT post duplicates required: true - label: I've read the [guidelines for opening an issue](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue) required: true - type: textarea id: description attributes: - label: Description - description: | - Provide an explanation of your site feature request in an arbitrary form. - Please make sure the description is worded well enough to be understood, see [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient). - Provide any additional information, any suggested solutions, and as much context and examples as possible - placeholder: WRITE DESCRIPTION HERE + label: Provide a description that is worded well enough to be understood + description: See [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient) + placeholder: Provide any additional information, any suggested solutions, and as much context and examples as possible validations: required: true + - type: checkboxes + id: verbose + attributes: + label: Provide verbose output that clearly demonstrates the problem + options: + - label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU `) + - label: Copy the WHOLE output (starting with `[debug] Command-line config`) and insert it below - type: textarea id: log attributes: - label: Verbose log + label: Complete Verbose Output description: | - If your feature request involves an existing yt-dlp command, provide the complete verbose output of that command. - Add the `-vU` flag to **your** command line you run yt-dlp with (`yt-dlp -vU `), copy the WHOLE output and insert it below. - It should look similar to this: + It should start like this: placeholder: | - [debug] Command-line config: ['-vU', 'http://www.youtube.com/watch?v=BaW_jenozKc'] - [debug] Portable config file: yt-dlp.conf - [debug] Portable config: ['-i'] - [debug] Encodings: locale cp1252, fs utf-8, stdout utf-8, stderr utf-8, pref cp1252 - [debug] yt-dlp version 2021.12.01 (exe) - [debug] Python version 3.8.8 (CPython 64bit) - Windows-10-10.0.19041-SP0 - [debug] exe versions: ffmpeg 3.0.1, ffprobe 3.0.1 - [debug] Optional libraries: Cryptodome, keyring, mutagen, sqlite, websockets + [debug] Command-line config: ['-vU', 'test:youtube'] + [debug] Portable config "yt-dlp.conf": ['-i'] + [debug] Encodings: locale cp65001, fs utf-8, pref cp65001, out utf-8, error utf-8, screen utf-8 + [debug] yt-dlp version 2022.06.29 [9d339c4] (win32_exe) + [debug] Python 3.8.10 (CPython 64bit) - Windows-10-10.0.22000-SP0 + [debug] Checking exe version: ffmpeg -bsfs + [debug] Checking exe version: ffprobe -bsfs + [debug] exe versions: ffmpeg N-106550-g072101bd52-20220410 (fdk,setts), ffprobe N-106624-g391ce570c8-20220415, phantomjs 2.1.1 + [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 [debug] Proxy map: {} - yt-dlp is up to date (2021.12.01) + [debug] Fetching release info: https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest + Latest version: 2022.06.29, Current version: 2022.06.29 + yt-dlp is up to date (2022.06.29) render: shell diff --git a/.github/ISSUE_TEMPLATE/6_question.yml b/.github/ISSUE_TEMPLATE/6_question.yml index 349dbd4ee4..8ef02bd9af 100644 --- a/.github/ISSUE_TEMPLATE/6_question.yml +++ b/.github/ISSUE_TEMPLATE/6_question.yml @@ -2,6 +2,12 @@ name: Ask question description: Ask yt-dlp related question labels: [question] body: + - type: markdown + attributes: + value: | + ### Make sure you are **only** asking a question and not reporting a bug or requesting a feature. + If your question contains "isn't working" or "can you add", this is most likely the wrong template. + If you are in doubt whether this is the right template, **use another template**! - type: checkboxes id: checklist attributes: @@ -15,41 +21,44 @@ body: required: true - label: I've verified that I'm running yt-dlp version **2022.06.29** ([update instructions](https://github.com/yt-dlp/yt-dlp#update)) or later (specify commit) required: true - - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar questions including closed ones. DO NOT post duplicates + - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar questions **including closed ones**. DO NOT post duplicates required: true - label: I've read the [guidelines for opening an issue](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue) required: true - type: textarea id: question attributes: - label: Question - description: | - Ask your question in an arbitrary form. - Please make sure it's worded well enough to be understood, see [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient). - Provide any additional information and as much context and examples as possible. - If your question contains "isn't working" or "can you add", this is most likely the wrong template. - If you are in doubt if this is the right template, use another template! - placeholder: WRITE QUESTION HERE + label: Please make sure the question is worded well enough to be understood + description: See [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient) + placeholder: Provide any additional information and as much context and examples as possible validations: required: true + - type: checkboxes + id: verbose + attributes: + label: Provide verbose output that clearly demonstrates the problem + options: + - label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU `) + - label: Copy the WHOLE output (starting with `[debug] Command-line config`) and insert it below - type: textarea id: log attributes: - label: Verbose log + label: Complete Verbose Output description: | - If your question involves a yt-dlp command, provide the complete verbose output of that command. - Add the `-vU` flag to **your** command line you run yt-dlp with (`yt-dlp -vU `), copy the WHOLE output and insert it below. - It should look similar to this: + It should start like this: placeholder: | - [debug] Command-line config: ['-vU', 'http://www.youtube.com/watch?v=BaW_jenozKc'] - [debug] Portable config file: yt-dlp.conf - [debug] Portable config: ['-i'] - [debug] Encodings: locale cp1252, fs utf-8, stdout utf-8, stderr utf-8, pref cp1252 - [debug] yt-dlp version 2021.12.01 (exe) - [debug] Python version 3.8.8 (CPython 64bit) - Windows-10-10.0.19041-SP0 - [debug] exe versions: ffmpeg 3.0.1, ffprobe 3.0.1 - [debug] Optional libraries: Cryptodome, keyring, mutagen, sqlite, websockets + [debug] Command-line config: ['-vU', 'test:youtube'] + [debug] Portable config "yt-dlp.conf": ['-i'] + [debug] Encodings: locale cp65001, fs utf-8, pref cp65001, out utf-8, error utf-8, screen utf-8 + [debug] yt-dlp version 2022.06.29 [9d339c4] (win32_exe) + [debug] Python 3.8.10 (CPython 64bit) - Windows-10-10.0.22000-SP0 + [debug] Checking exe version: ffmpeg -bsfs + [debug] Checking exe version: ffprobe -bsfs + [debug] exe versions: ffmpeg N-106550-g072101bd52-20220410 (fdk,setts), ffprobe N-106624-g391ce570c8-20220415, phantomjs 2.1.1 + [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 [debug] Proxy map: {} - yt-dlp is up to date (2021.12.01) + [debug] Fetching release info: https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest + Latest version: 2022.06.29, Current version: 2022.06.29 + yt-dlp is up to date (2022.06.29) render: shell diff --git a/.github/ISSUE_TEMPLATE_tmpl/1_broken_site.yml b/.github/ISSUE_TEMPLATE_tmpl/1_broken_site.yml index 3d7f9d04e7..c6d7cd40bf 100644 --- a/.github/ISSUE_TEMPLATE_tmpl/1_broken_site.yml +++ b/.github/ISSUE_TEMPLATE_tmpl/1_broken_site.yml @@ -17,7 +17,7 @@ body: required: true - label: I've checked that all URLs and arguments with special characters are [properly quoted or escaped](https://github.com/ytdl-org/youtube-dl#video-url-contains-an-ampersand-and-im-getting-some-strange-output-1-2839-or-v-is-not-recognized-as-an-internal-or-external-command) required: true - - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues including closed ones. DO NOT post duplicates + - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues **including closed ones**. DO NOT post duplicates required: true - label: I've read the [guidelines for opening an issue](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue) required: true @@ -26,38 +26,14 @@ body: id: region attributes: label: Region - description: "Enter the region the site is accessible from" - placeholder: "India" + description: Enter the country/region that the site is accessible from + placeholder: India - type: textarea id: description attributes: - label: Description - description: | - Provide an explanation of your issue in an arbitrary form. - Provide any additional information, any suggested solutions, and as much context and examples as possible - placeholder: WRITE DESCRIPTION HERE - validations: - required: true - - type: textarea - id: log - attributes: - label: Verbose log - description: | - Provide the complete verbose output of yt-dlp **that clearly demonstrates the problem**. - Add the `-vU` flag to your command line you run yt-dlp with (`yt-dlp -vU `), copy the WHOLE output and insert it below. - It should look similar to this: - placeholder: | - [debug] Command-line config: ['-vU', 'http://www.youtube.com/watch?v=BaW_jenozKc'] - [debug] Portable config file: yt-dlp.conf - [debug] Portable config: ['-i'] - [debug] Encodings: locale cp1252, fs utf-8, stdout utf-8, stderr utf-8, pref cp1252 - [debug] yt-dlp version %(version)s (exe) - [debug] Python version 3.8.8 (CPython 64bit) - Windows-10-10.0.19041-SP0 - [debug] exe versions: ffmpeg 3.0.1, ffprobe 3.0.1 - [debug] Optional libraries: Cryptodome, keyring, mutagen, sqlite, websockets - [debug] Proxy map: {} - yt-dlp is up to date (%(version)s) - - render: shell + label: Provide a description that is worded well enough to be understood + description: See [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient) + placeholder: Provide any additional information, any suggested solutions, and as much context and examples as possible validations: required: true + %(verbose)s diff --git a/.github/ISSUE_TEMPLATE_tmpl/2_site_support_request.yml b/.github/ISSUE_TEMPLATE_tmpl/2_site_support_request.yml index fc7306b618..07f7445891 100644 --- a/.github/ISSUE_TEMPLATE_tmpl/2_site_support_request.yml +++ b/.github/ISSUE_TEMPLATE_tmpl/2_site_support_request.yml @@ -17,7 +17,7 @@ body: required: true - label: I've checked that none of provided URLs [violate any copyrights](https://github.com/ytdl-org/youtube-dl#can-you-add-support-for-this-anime-video-site-or-site-which-shows-current-movies-for-free) or contain any [DRM](https://en.wikipedia.org/wiki/Digital_rights_management) to the best of my knowledge required: true - - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues including closed ones. DO NOT post duplicates + - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues **including closed ones**. DO NOT post duplicates required: true - label: I've read the [guidelines for opening an issue](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue) required: true @@ -26,8 +26,8 @@ body: id: region attributes: label: Region - description: "Enter the region the site is accessible from" - placeholder: "India" + description: Enter the country/region that the site is accessible from + placeholder: India - type: textarea id: example-urls attributes: @@ -43,32 +43,9 @@ body: - type: textarea id: description attributes: - label: Description - description: | - Provide any additional information - placeholder: WRITE DESCRIPTION HERE - validations: - required: true - - type: textarea - id: log - attributes: - label: Verbose log - description: | - Provide the complete verbose output **using one of the example URLs provided above**. - Add the `-vU` flag to your command line you run yt-dlp with (`yt-dlp -vU `), copy the WHOLE output and insert it below. - It should look similar to this: - placeholder: | - [debug] Command-line config: ['-vU', 'http://www.youtube.com/watch?v=BaW_jenozKc'] - [debug] Portable config file: yt-dlp.conf - [debug] Portable config: ['-i'] - [debug] Encodings: locale cp1252, fs utf-8, stdout utf-8, stderr utf-8, pref cp1252 - [debug] yt-dlp version %(version)s (exe) - [debug] Python version 3.8.8 (CPython 64bit) - Windows-10-10.0.19041-SP0 - [debug] exe versions: ffmpeg 3.0.1, ffprobe 3.0.1 - [debug] Optional libraries: Cryptodome, keyring, mutagen, sqlite, websockets - [debug] Proxy map: {} - yt-dlp is up to date (%(version)s) - - render: shell + label: Provide a description that is worded well enough to be understood + description: See [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient) + placeholder: Provide any additional information, any suggested solutions, and as much context and examples as possible validations: required: true + %(verbose)s diff --git a/.github/ISSUE_TEMPLATE_tmpl/3_site_feature_request.yml b/.github/ISSUE_TEMPLATE_tmpl/3_site_feature_request.yml index 77e9d3469c..dfd07a9f85 100644 --- a/.github/ISSUE_TEMPLATE_tmpl/3_site_feature_request.yml +++ b/.github/ISSUE_TEMPLATE_tmpl/3_site_feature_request.yml @@ -15,7 +15,7 @@ body: required: true - label: I've checked that all provided URLs are playable in a browser with the same IP and same login details required: true - - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues including closed ones. DO NOT post duplicates + - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues **including closed ones**. DO NOT post duplicates required: true - label: I've read the [guidelines for opening an issue](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue) required: true @@ -24,8 +24,8 @@ body: id: region attributes: label: Region - description: "Enter the region the site is accessible from" - placeholder: "India" + description: Enter the country/region that the site is accessible from + placeholder: India - type: textarea id: example-urls attributes: @@ -39,34 +39,9 @@ body: - type: textarea id: description attributes: - label: Description - description: | - Provide an explanation of your site feature request in an arbitrary form. - Please make sure the description is worded well enough to be understood, see [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient). - Provide any additional information, any suggested solutions, and as much context and examples as possible - placeholder: WRITE DESCRIPTION HERE - validations: - required: true - - type: textarea - id: log - attributes: - label: Verbose log - description: | - Provide the complete verbose output of yt-dlp that demonstrates the need for the enhancement. - Add the `-vU` flag to your command line you run yt-dlp with (`yt-dlp -vU `), copy the WHOLE output and insert it below. - It should look similar to this: - placeholder: | - [debug] Command-line config: ['-vU', 'http://www.youtube.com/watch?v=BaW_jenozKc'] - [debug] Portable config file: yt-dlp.conf - [debug] Portable config: ['-i'] - [debug] Encodings: locale cp1252, fs utf-8, stdout utf-8, stderr utf-8, pref cp1252 - [debug] yt-dlp version %(version)s (exe) - [debug] Python version 3.8.8 (CPython 64bit) - Windows-10-10.0.19041-SP0 - [debug] exe versions: ffmpeg 3.0.1, ffprobe 3.0.1 - [debug] Optional libraries: Cryptodome, keyring, mutagen, sqlite, websockets - [debug] Proxy map: {} - yt-dlp is up to date (%(version)s) - - render: shell + label: Provide a description that is worded well enough to be understood + description: See [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient) + placeholder: Provide any additional information, any suggested solutions, and as much context and examples as possible validations: required: true + %(verbose)s diff --git a/.github/ISSUE_TEMPLATE_tmpl/4_bug_report.yml b/.github/ISSUE_TEMPLATE_tmpl/4_bug_report.yml index bb9d94c330..cffe06fe3b 100644 --- a/.github/ISSUE_TEMPLATE_tmpl/4_bug_report.yml +++ b/.github/ISSUE_TEMPLATE_tmpl/4_bug_report.yml @@ -17,41 +17,16 @@ body: required: true - label: I've checked that all URLs and arguments with special characters are [properly quoted or escaped](https://github.com/ytdl-org/youtube-dl#video-url-contains-an-ampersand-and-im-getting-some-strange-output-1-2839-or-v-is-not-recognized-as-an-internal-or-external-command) required: true - - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues including closed ones. DO NOT post duplicates + - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues **including closed ones**. DO NOT post duplicates required: true - label: I've read the [guidelines for opening an issue](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue) required: true - type: textarea id: description attributes: - label: Description - description: | - Provide an explanation of your issue in an arbitrary form. - Please make sure the description is worded well enough to be understood, see [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient). - Provide any additional information, any suggested solutions, and as much context and examples as possible - placeholder: WRITE DESCRIPTION HERE - validations: - required: true - - type: textarea - id: log - attributes: - label: Verbose log - description: | - Provide the complete verbose output of yt-dlp **that clearly demonstrates the problem**. - Add the `-vU` flag to **your** command line you run yt-dlp with (`yt-dlp -vU `), copy the WHOLE output and insert it below. - It should look similar to this: - placeholder: | - [debug] Command-line config: ['-vU', 'http://www.youtube.com/watch?v=BaW_jenozKc'] - [debug] Portable config file: yt-dlp.conf - [debug] Portable config: ['-i'] - [debug] Encodings: locale cp1252, fs utf-8, stdout utf-8, stderr utf-8, pref cp1252 - [debug] yt-dlp version %(version)s (exe) - [debug] Python version 3.8.8 (CPython 64bit) - Windows-10-10.0.19041-SP0 - [debug] exe versions: ffmpeg 3.0.1, ffprobe 3.0.1 - [debug] Optional libraries: Cryptodome, keyring, mutagen, sqlite, websockets - [debug] Proxy map: {} - yt-dlp is up to date (%(version)s) - - render: shell + label: Provide a description that is worded well enough to be understood + description: See [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient) + placeholder: Provide any additional information, any suggested solutions, and as much context and examples as possible validations: required: true + %(verbose)s diff --git a/.github/ISSUE_TEMPLATE_tmpl/5_feature_request.yml b/.github/ISSUE_TEMPLATE_tmpl/5_feature_request.yml index 4686c1dff3..dc6709bcf6 100644 --- a/.github/ISSUE_TEMPLATE_tmpl/5_feature_request.yml +++ b/.github/ISSUE_TEMPLATE_tmpl/5_feature_request.yml @@ -15,39 +15,16 @@ body: required: true - label: I've verified that I'm running yt-dlp version **%(version)s** ([update instructions](https://github.com/yt-dlp/yt-dlp#update)) or later (specify commit) required: true - - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues including closed ones. DO NOT post duplicates + - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar issues **including closed ones**. DO NOT post duplicates required: true - label: I've read the [guidelines for opening an issue](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue) required: true - type: textarea id: description attributes: - label: Description - description: | - Provide an explanation of your site feature request in an arbitrary form. - Please make sure the description is worded well enough to be understood, see [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient). - Provide any additional information, any suggested solutions, and as much context and examples as possible - placeholder: WRITE DESCRIPTION HERE + label: Provide a description that is worded well enough to be understood + description: See [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient) + placeholder: Provide any additional information, any suggested solutions, and as much context and examples as possible validations: required: true - - type: textarea - id: log - attributes: - label: Verbose log - description: | - If your feature request involves an existing yt-dlp command, provide the complete verbose output of that command. - Add the `-vU` flag to **your** command line you run yt-dlp with (`yt-dlp -vU `), copy the WHOLE output and insert it below. - It should look similar to this: - placeholder: | - [debug] Command-line config: ['-vU', 'http://www.youtube.com/watch?v=BaW_jenozKc'] - [debug] Portable config file: yt-dlp.conf - [debug] Portable config: ['-i'] - [debug] Encodings: locale cp1252, fs utf-8, stdout utf-8, stderr utf-8, pref cp1252 - [debug] yt-dlp version 2021.12.01 (exe) - [debug] Python version 3.8.8 (CPython 64bit) - Windows-10-10.0.19041-SP0 - [debug] exe versions: ffmpeg 3.0.1, ffprobe 3.0.1 - [debug] Optional libraries: Cryptodome, keyring, mutagen, sqlite, websockets - [debug] Proxy map: {} - yt-dlp is up to date (2021.12.01) - - render: shell + %(verbose_optional)s diff --git a/.github/ISSUE_TEMPLATE_tmpl/6_question.yml b/.github/ISSUE_TEMPLATE_tmpl/6_question.yml index 8936f096be..8cb8bba52d 100644 --- a/.github/ISSUE_TEMPLATE_tmpl/6_question.yml +++ b/.github/ISSUE_TEMPLATE_tmpl/6_question.yml @@ -2,6 +2,12 @@ name: Ask question description: Ask yt-dlp related question labels: [question] body: + - type: markdown + attributes: + value: | + ### Make sure you are **only** asking a question and not reporting a bug or requesting a feature. + If your question contains "isn't working" or "can you add", this is most likely the wrong template. + If you are in doubt whether this is the right template, **use another template**! - type: checkboxes id: checklist attributes: @@ -15,41 +21,16 @@ body: required: true - label: I've verified that I'm running yt-dlp version **%(version)s** ([update instructions](https://github.com/yt-dlp/yt-dlp#update)) or later (specify commit) required: true - - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar questions including closed ones. DO NOT post duplicates + - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=) for similar questions **including closed ones**. DO NOT post duplicates required: true - label: I've read the [guidelines for opening an issue](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#opening-an-issue) required: true - type: textarea id: question attributes: - label: Question - description: | - Ask your question in an arbitrary form. - Please make sure it's worded well enough to be understood, see [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient). - Provide any additional information and as much context and examples as possible. - If your question contains "isn't working" or "can you add", this is most likely the wrong template. - If you are in doubt if this is the right template, use another template! - placeholder: WRITE QUESTION HERE + label: Please make sure the question is worded well enough to be understood + description: See [is-the-description-of-the-issue-itself-sufficient](https://github.com/ytdl-org/youtube-dl#is-the-description-of-the-issue-itself-sufficient) + placeholder: Provide any additional information and as much context and examples as possible validations: required: true - - type: textarea - id: log - attributes: - label: Verbose log - description: | - If your question involves a yt-dlp command, provide the complete verbose output of that command. - Add the `-vU` flag to **your** command line you run yt-dlp with (`yt-dlp -vU `), copy the WHOLE output and insert it below. - It should look similar to this: - placeholder: | - [debug] Command-line config: ['-vU', 'http://www.youtube.com/watch?v=BaW_jenozKc'] - [debug] Portable config file: yt-dlp.conf - [debug] Portable config: ['-i'] - [debug] Encodings: locale cp1252, fs utf-8, stdout utf-8, stderr utf-8, pref cp1252 - [debug] yt-dlp version 2021.12.01 (exe) - [debug] Python version 3.8.8 (CPython 64bit) - Windows-10-10.0.19041-SP0 - [debug] exe versions: ffmpeg 3.0.1, ffprobe 3.0.1 - [debug] Optional libraries: Cryptodome, keyring, mutagen, sqlite, websockets - [debug] Proxy map: {} - yt-dlp is up to date (2021.12.01) - - render: shell + %(verbose_optional)s diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 14d4da52e5..915fecb494 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,5 +1,8 @@ +
Template + + +DESCRIPTION + +Fixes # diff --git a/devscripts/make_issue_template.py b/devscripts/make_issue_template.py index 54043ef4ee..90e7e0b43e 100644 --- a/devscripts/make_issue_template.py +++ b/devscripts/make_issue_template.py @@ -8,6 +8,7 @@ import optparse +import re def read(fname): @@ -21,16 +22,56 @@ def read_version(fname): return locals()['__version__'] +VERBOSE_TMPL = ''' + - type: checkboxes + id: verbose + attributes: + label: Provide verbose output that clearly demonstrates the problem + options: + - label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU `) + required: true + - label: Copy the WHOLE output (starting with `[debug] Command-line config`) and insert it below + required: true + - type: textarea + id: log + attributes: + label: Complete Verbose Output + description: | + It should start like this: + placeholder: | + [debug] Command-line config: ['-vU', 'test:youtube'] + [debug] Portable config "yt-dlp.conf": ['-i'] + [debug] Encodings: locale cp65001, fs utf-8, pref cp65001, out utf-8, error utf-8, screen utf-8 + [debug] yt-dlp version %(version)s [9d339c4] (win32_exe) + [debug] Python 3.8.10 (CPython 64bit) - Windows-10-10.0.22000-SP0 + [debug] Checking exe version: ffmpeg -bsfs + [debug] Checking exe version: ffprobe -bsfs + [debug] exe versions: ffmpeg N-106550-g072101bd52-20220410 (fdk,setts), ffprobe N-106624-g391ce570c8-20220415, phantomjs 2.1.1 + [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 + [debug] Proxy map: {} + [debug] Fetching release info: https://api.github.com/repos/yt-dlp/yt-dlp/releases/latest + Latest version: %(version)s, Current version: %(version)s + yt-dlp is up to date (%(version)s) + + render: shell + validations: + required: true +'''.strip() + + def main(): parser = optparse.OptionParser(usage='%prog INFILE OUTFILE') - options, args = parser.parse_args() + _, args = parser.parse_args() if len(args) != 2: parser.error('Expected an input and an output filename') + fields = {'version': read_version('yt_dlp/version.py')} + fields['verbose'] = VERBOSE_TMPL % fields + fields['verbose_optional'] = re.sub(r'(\n\s+validations:)?\n\s+required: true', '', fields['verbose']) + infile, outfile = args with open(outfile, 'w', encoding='utf-8') as outf: - outf.write( - read(infile) % {'version': read_version('yt_dlp/version.py')}) + outf.write(read(infile) % fields) if __name__ == '__main__':