From 517ddf3c3f12560ab93e3d36244dc82db9f97818 Mon Sep 17 00:00:00 2001
From: sepro <sepro@sepr0.com>
Date: Sat, 8 Feb 2025 17:00:38 +0100
Subject: [PATCH] [misc] Improve Issue/PR templates (#11499)
Authored by: seproDev
---
.github/ISSUE_TEMPLATE/1_broken_site.yml | 24 ++++--------
.../ISSUE_TEMPLATE/2_site_support_request.yml | 24 ++++--------
.../ISSUE_TEMPLATE/3_site_feature_request.yml | 26 ++++---------
.github/ISSUE_TEMPLATE/4_bug_report.yml | 28 ++++----------
.github/ISSUE_TEMPLATE/5_feature_request.yml | 26 ++++---------
.github/ISSUE_TEMPLATE/6_question.yml | 26 ++++---------
.github/ISSUE_TEMPLATE/config.yml | 7 +---
.github/ISSUE_TEMPLATE_tmpl/1_broken_site.yml | 4 +-
.../2_site_support_request.yml | 4 +-
.../3_site_feature_request.yml | 6 +--
.github/ISSUE_TEMPLATE_tmpl/4_bug_report.yml | 8 +---
.../ISSUE_TEMPLATE_tmpl/5_feature_request.yml | 6 +--
.github/ISSUE_TEMPLATE_tmpl/6_question.yml | 6 +--
.github/PULL_REQUEST_TEMPLATE.md | 37 ++++++++++---------
README.md | 1 -
devscripts/make_issue_template.py | 30 ++++++---------
16 files changed, 87 insertions(+), 176 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/1_broken_site.yml b/.github/ISSUE_TEMPLATE/1_broken_site.yml
index 20e5e944f..fd7591ba2 100644
--- a/.github/ISSUE_TEMPLATE/1_broken_site.yml
+++ b/.github/ISSUE_TEMPLATE/1_broken_site.yml
@@ -2,13 +2,11 @@ name: Broken site support
description: Report issue with yt-dlp on a supported site
labels: [triage, site-bug]
body:
- - type: checkboxes
+ - type: markdown
attributes:
- label: DO NOT REMOVE OR SKIP THE ISSUE TEMPLATE
- description: Fill all fields even if you think it is irrelevant for the issue
- options:
- - label: I understand that I will be **blocked** if I *intentionally* remove or skip any mandatory\* field
- required: true
+ value: |
+ > [!IMPORTANT]
+ > Not providing the required (*) information will result in your issue being closed and ignored.
- type: checkboxes
id: checklist
attributes:
@@ -24,9 +22,7 @@ body:
required: true
- label: I've checked that all URLs and arguments with special characters are [properly quoted or escaped](https://github.com/yt-dlp/yt-dlp/wiki/FAQ#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 [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
- 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)
+ - label: I've searched [known issues](https://github.com/yt-dlp/yt-dlp/issues/3766), [the FAQ](https://github.com/yt-dlp/yt-dlp/wiki/FAQ), and the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=is%3Aissue%20-label%3Aspam%20%20) for similar issues **including closed ones**. DO NOT post duplicates
required: true
- label: I've read about [sharing account credentials](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#are-you-willing-to-share-account-details-if-needed) and I'm willing to share it if required
- type: input
@@ -47,6 +43,8 @@ body:
id: verbose
attributes:
label: Provide verbose output that clearly demonstrates the problem
+ description: |
+ This is mandatory unless absolutely impossible to provide. If you are unable to provide the output, please explain why.
options:
- label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU <your command line>`)
required: true
@@ -78,11 +76,3 @@ body:
render: shell
validations:
required: true
- - type: markdown
- attributes:
- value: |
- > [!CAUTION]
- > ### GitHub is experiencing a high volume of malicious spam comments.
- > ### If you receive any replies asking you download a file, do NOT follow the download links!
- >
- > Note that this issue may be temporarily locked as an anti-spam measure after it is opened.
diff --git a/.github/ISSUE_TEMPLATE/2_site_support_request.yml b/.github/ISSUE_TEMPLATE/2_site_support_request.yml
index 4aeff7dc6..111f423d0 100644
--- a/.github/ISSUE_TEMPLATE/2_site_support_request.yml
+++ b/.github/ISSUE_TEMPLATE/2_site_support_request.yml
@@ -2,13 +2,11 @@ name: Site support request
description: Request support for a new site
labels: [triage, site-request]
body:
- - type: checkboxes
+ - type: markdown
attributes:
- label: DO NOT REMOVE OR SKIP THE ISSUE TEMPLATE
- description: Fill all fields even if you think it is irrelevant for the issue
- options:
- - label: I understand that I will be **blocked** if I *intentionally* remove or skip any mandatory\* field
- required: true
+ value: |
+ > [!IMPORTANT]
+ > Not providing the required (*) information will result in your issue being closed and ignored.
- type: checkboxes
id: checklist
attributes:
@@ -24,9 +22,7 @@ body:
required: true
- label: I've checked that none of provided URLs [violate any copyrights](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#is-the-website-primarily-used-for-piracy) or contain any [DRM](https://en.wikipedia.org/wiki/Digital_rights_management) to the best of my knowledge
required: true
- - 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
- 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)
+ - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=is%3Aissue%20-label%3Aspam%20%20) for similar requests **including closed ones**. DO NOT post duplicates
required: true
- label: I've read about [sharing account credentials](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#are-you-willing-to-share-account-details-if-needed) and am willing to share it if required
- type: input
@@ -59,6 +55,8 @@ body:
id: verbose
attributes:
label: Provide verbose output that clearly demonstrates the problem
+ description: |
+ This is mandatory unless absolutely impossible to provide. If you are unable to provide the output, please explain why.
options:
- label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU <your command line>`)
required: true
@@ -90,11 +88,3 @@ body:
render: shell
validations:
required: true
- - type: markdown
- attributes:
- value: |
- > [!CAUTION]
- > ### GitHub is experiencing a high volume of malicious spam comments.
- > ### If you receive any replies asking you download a file, do NOT follow the download links!
- >
- > Note that this issue may be temporarily locked as an anti-spam measure after it is opened.
diff --git a/.github/ISSUE_TEMPLATE/3_site_feature_request.yml b/.github/ISSUE_TEMPLATE/3_site_feature_request.yml
index 2f516ebb7..fd74be331 100644
--- a/.github/ISSUE_TEMPLATE/3_site_feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/3_site_feature_request.yml
@@ -1,14 +1,12 @@
name: Site feature request
-description: Request a new functionality for a supported site
+description: Request new functionality for a site supported by yt-dlp
labels: [triage, site-enhancement]
body:
- - type: checkboxes
+ - type: markdown
attributes:
- label: DO NOT REMOVE OR SKIP THE ISSUE TEMPLATE
- description: Fill all fields even if you think it is irrelevant for the issue
- options:
- - label: I understand that I will be **blocked** if I *intentionally* remove or skip any mandatory\* field
- required: true
+ value: |
+ > [!IMPORTANT]
+ > Not providing the required (*) information will result in your issue being closed and ignored.
- type: checkboxes
id: checklist
attributes:
@@ -22,9 +20,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 [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
- 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)
+ - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=is%3Aissue%20-label%3Aspam%20%20) for similar requests **including closed ones**. DO NOT post duplicates
required: true
- label: I've read about [sharing account credentials](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#are-you-willing-to-share-account-details-if-needed) and I'm willing to share it if required
- type: input
@@ -55,6 +51,8 @@ body:
id: verbose
attributes:
label: Provide verbose output that clearly demonstrates the problem
+ description: |
+ This is mandatory unless absolutely impossible to provide. If you are unable to provide the output, please explain why.
options:
- label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU <your command line>`)
required: true
@@ -86,11 +84,3 @@ body:
render: shell
validations:
required: true
- - type: markdown
- attributes:
- value: |
- > [!CAUTION]
- > ### GitHub is experiencing a high volume of malicious spam comments.
- > ### If you receive any replies asking you download a file, do NOT follow the download links!
- >
- > Note that this issue may be temporarily locked as an anti-spam measure after it is opened.
diff --git a/.github/ISSUE_TEMPLATE/4_bug_report.yml b/.github/ISSUE_TEMPLATE/4_bug_report.yml
index 201586e9d..e9ec45e14 100644
--- a/.github/ISSUE_TEMPLATE/4_bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/4_bug_report.yml
@@ -2,13 +2,11 @@ name: Core bug report
description: Report a bug unrelated to any particular site or extractor
labels: [triage, bug]
body:
- - type: checkboxes
+ - type: markdown
attributes:
- label: DO NOT REMOVE OR SKIP THE ISSUE TEMPLATE
- description: Fill all fields even if you think it is irrelevant for the issue
- options:
- - label: I understand that I will be **blocked** if I *intentionally* remove or skip any mandatory\* field
- required: true
+ value: |
+ > [!IMPORTANT]
+ > Not providing the required (*) information will result in your issue being closed and ignored.
- type: checkboxes
id: checklist
attributes:
@@ -20,13 +18,7 @@ body:
required: true
- 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))
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 checked that all URLs and arguments with special characters are [properly quoted or escaped](https://github.com/yt-dlp/yt-dlp/wiki/FAQ#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 [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
- 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)
+ - label: I've searched [known issues](https://github.com/yt-dlp/yt-dlp/issues/3766), [the FAQ](https://github.com/yt-dlp/yt-dlp/wiki/FAQ), and the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=is%3Aissue%20-label%3Aspam%20%20) for similar issues **including closed ones**. DO NOT post duplicates
required: true
- type: textarea
id: description
@@ -40,6 +32,8 @@ body:
id: verbose
attributes:
label: Provide verbose output that clearly demonstrates the problem
+ description: |
+ This is mandatory unless absolutely impossible to provide. If you are unable to provide the output, please explain why.
options:
- label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU <your command line>`)
required: true
@@ -71,11 +65,3 @@ body:
render: shell
validations:
required: true
- - type: markdown
- attributes:
- value: |
- > [!CAUTION]
- > ### GitHub is experiencing a high volume of malicious spam comments.
- > ### If you receive any replies asking you download a file, do NOT follow the download links!
- >
- > Note that this issue may be temporarily locked as an anti-spam measure after it is opened.
diff --git a/.github/ISSUE_TEMPLATE/5_feature_request.yml b/.github/ISSUE_TEMPLATE/5_feature_request.yml
index 765de86a2..9c7d66d81 100644
--- a/.github/ISSUE_TEMPLATE/5_feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/5_feature_request.yml
@@ -1,14 +1,12 @@
name: Feature request
-description: Request a new functionality unrelated to any particular site or extractor
+description: Request a new feature unrelated to any particular site or extractor
labels: [triage, enhancement]
body:
- - type: checkboxes
+ - type: markdown
attributes:
- label: DO NOT REMOVE OR SKIP THE ISSUE TEMPLATE
- description: Fill all fields even if you think it is irrelevant for the issue
- options:
- - label: I understand that I will be **blocked** if I *intentionally* remove or skip any mandatory\* field
- required: true
+ value: |
+ > [!IMPORTANT]
+ > Not providing the required (*) information will result in your issue being closed and ignored.
- type: checkboxes
id: checklist
attributes:
@@ -22,9 +20,7 @@ body:
required: true
- 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))
required: true
- - 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
- 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)
+ - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=is%3Aissue%20-label%3Aspam%20%20) for similar requests **including closed ones**. DO NOT post duplicates
required: true
- type: textarea
id: description
@@ -38,6 +34,8 @@ body:
id: verbose
attributes:
label: Provide verbose output that clearly demonstrates the problem
+ description: |
+ This is mandatory unless absolutely impossible to provide. If you are unable to provide the output, please explain why.
options:
- label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU <your command line>`)
- label: "If using API, add `'verbose': True` to `YoutubeDL` params instead"
@@ -65,11 +63,3 @@ body:
[youtube] Extracting URL: https://www.youtube.com/watch?v=BaW_jenozKc
<more lines>
render: shell
- - type: markdown
- attributes:
- value: |
- > [!CAUTION]
- > ### GitHub is experiencing a high volume of malicious spam comments.
- > ### If you receive any replies asking you download a file, do NOT follow the download links!
- >
- > Note that this issue may be temporarily locked as an anti-spam measure after it is opened.
diff --git a/.github/ISSUE_TEMPLATE/6_question.yml b/.github/ISSUE_TEMPLATE/6_question.yml
index 198e21bec..186f73a4a 100644
--- a/.github/ISSUE_TEMPLATE/6_question.yml
+++ b/.github/ISSUE_TEMPLATE/6_question.yml
@@ -1,14 +1,12 @@
name: Ask question
-description: Ask yt-dlp related question
+description: Ask a question about using yt-dlp
labels: [question]
body:
- - type: checkboxes
+ - type: markdown
attributes:
- label: DO NOT REMOVE OR SKIP THE ISSUE TEMPLATE
- description: Fill all fields even if you think it is irrelevant for the issue
- options:
- - label: I understand that I will be **blocked** if I *intentionally* remove or skip any mandatory\* field
- required: true
+ value: |
+ > [!IMPORTANT]
+ > Not providing the required (*) information will result in your issue being closed and ignored.
- type: markdown
attributes:
value: |
@@ -28,9 +26,7 @@ body:
required: true
- 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))
required: true
- - 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 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)
+ - label: I've searched [known issues](https://github.com/yt-dlp/yt-dlp/issues/3766), [the FAQ](https://github.com/yt-dlp/yt-dlp/wiki/FAQ), and the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=is%3Aissue%20-label%3Aspam%20%20) for similar questions **including closed ones**. DO NOT post duplicates
required: true
- type: textarea
id: question
@@ -44,6 +40,8 @@ body:
id: verbose
attributes:
label: Provide verbose output that clearly demonstrates the problem
+ description: |
+ This is mandatory unless absolutely impossible to provide. If you are unable to provide the output, please explain why.
options:
- label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU <your command line>`)
- label: "If using API, add `'verbose': True` to `YoutubeDL` params instead"
@@ -71,11 +69,3 @@ body:
[youtube] Extracting URL: https://www.youtube.com/watch?v=BaW_jenozKc
<more lines>
render: shell
- - type: markdown
- attributes:
- value: |
- > [!CAUTION]
- > ### GitHub is experiencing a high volume of malicious spam comments.
- > ### If you receive any replies asking you download a file, do NOT follow the download links!
- >
- > Note that this issue may be temporarily locked as an anti-spam measure after it is opened.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 9cdffa4b1..0131631bb 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,8 +1,5 @@
blank_issues_enabled: false
contact_links:
- - name: Get help from the community on Discord
+ - name: Get help on Discord
url: https://discord.gg/H5MNcFW63r
- about: Join the yt-dlp Discord for community-powered support!
- - name: Matrix Bridge to the Discord server
- url: https://matrix.to/#/#yt-dlp:matrix.org
- about: For those who do not want to use Discord
+ about: Join the yt-dlp Discord server for support and discussion
diff --git a/.github/ISSUE_TEMPLATE_tmpl/1_broken_site.yml b/.github/ISSUE_TEMPLATE_tmpl/1_broken_site.yml
index bff28ae4e..f1a2d3090 100644
--- a/.github/ISSUE_TEMPLATE_tmpl/1_broken_site.yml
+++ b/.github/ISSUE_TEMPLATE_tmpl/1_broken_site.yml
@@ -18,9 +18,7 @@ body:
required: true
- label: I've checked that all URLs and arguments with special characters are [properly quoted or escaped](https://github.com/yt-dlp/yt-dlp/wiki/FAQ#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 [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
- 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)
+ - label: I've searched [known issues](https://github.com/yt-dlp/yt-dlp/issues/3766), [the FAQ](https://github.com/yt-dlp/yt-dlp/wiki/FAQ), and the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=is%%3Aissue%%20-label%%3Aspam%%20%%20) for similar issues **including closed ones**. DO NOT post duplicates
required: true
- label: I've read about [sharing account credentials](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#are-you-willing-to-share-account-details-if-needed) and I'm willing to share it if required
- type: input
diff --git a/.github/ISSUE_TEMPLATE_tmpl/2_site_support_request.yml b/.github/ISSUE_TEMPLATE_tmpl/2_site_support_request.yml
index 2bffe738d..31b89b683 100644
--- a/.github/ISSUE_TEMPLATE_tmpl/2_site_support_request.yml
+++ b/.github/ISSUE_TEMPLATE_tmpl/2_site_support_request.yml
@@ -18,9 +18,7 @@ body:
required: true
- label: I've checked that none of provided URLs [violate any copyrights](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#is-the-website-primarily-used-for-piracy) or contain any [DRM](https://en.wikipedia.org/wiki/Digital_rights_management) to the best of my knowledge
required: true
- - 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
- 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)
+ - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=is%%3Aissue%%20-label%%3Aspam%%20%%20) for similar requests **including closed ones**. DO NOT post duplicates
required: true
- label: I've read about [sharing account credentials](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#are-you-willing-to-share-account-details-if-needed) and am willing to share it if required
- type: input
diff --git a/.github/ISSUE_TEMPLATE_tmpl/3_site_feature_request.yml b/.github/ISSUE_TEMPLATE_tmpl/3_site_feature_request.yml
index 6c3127983..421766a75 100644
--- a/.github/ISSUE_TEMPLATE_tmpl/3_site_feature_request.yml
+++ b/.github/ISSUE_TEMPLATE_tmpl/3_site_feature_request.yml
@@ -1,5 +1,5 @@
name: Site feature request
-description: Request a new functionality for a supported site
+description: Request new functionality for a site supported by yt-dlp
labels: [triage, site-enhancement]
body:
%(no_skip)s
@@ -16,9 +16,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 [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
- 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)
+ - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=is%%3Aissue%%20-label%%3Aspam%%20%%20) for similar requests **including closed ones**. DO NOT post duplicates
required: true
- label: I've read about [sharing account credentials](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#are-you-willing-to-share-account-details-if-needed) and I'm willing to share it if required
- type: input
diff --git a/.github/ISSUE_TEMPLATE_tmpl/4_bug_report.yml b/.github/ISSUE_TEMPLATE_tmpl/4_bug_report.yml
index 5f357d96e..31a19b292 100644
--- a/.github/ISSUE_TEMPLATE_tmpl/4_bug_report.yml
+++ b/.github/ISSUE_TEMPLATE_tmpl/4_bug_report.yml
@@ -14,13 +14,7 @@ body:
required: true
- 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))
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 checked that all URLs and arguments with special characters are [properly quoted or escaped](https://github.com/yt-dlp/yt-dlp/wiki/FAQ#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 [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
- 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)
+ - label: I've searched [known issues](https://github.com/yt-dlp/yt-dlp/issues/3766), [the FAQ](https://github.com/yt-dlp/yt-dlp/wiki/FAQ), and the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=is%%3Aissue%%20-label%%3Aspam%%20%%20) for similar issues **including closed ones**. DO NOT post duplicates
required: true
- type: textarea
id: description
diff --git a/.github/ISSUE_TEMPLATE_tmpl/5_feature_request.yml b/.github/ISSUE_TEMPLATE_tmpl/5_feature_request.yml
index 99107ff58..b8ab6610b 100644
--- a/.github/ISSUE_TEMPLATE_tmpl/5_feature_request.yml
+++ b/.github/ISSUE_TEMPLATE_tmpl/5_feature_request.yml
@@ -1,5 +1,5 @@
name: Feature request
-description: Request a new functionality unrelated to any particular site or extractor
+description: Request a new feature unrelated to any particular site or extractor
labels: [triage, enhancement]
body:
%(no_skip)s
@@ -16,9 +16,7 @@ body:
required: true
- 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))
required: true
- - 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
- 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)
+ - label: I've searched the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=is%%3Aissue%%20-label%%3Aspam%%20%%20) for similar requests **including closed ones**. DO NOT post duplicates
required: true
- type: textarea
id: description
diff --git a/.github/ISSUE_TEMPLATE_tmpl/6_question.yml b/.github/ISSUE_TEMPLATE_tmpl/6_question.yml
index bd742109a..062e96321 100644
--- a/.github/ISSUE_TEMPLATE_tmpl/6_question.yml
+++ b/.github/ISSUE_TEMPLATE_tmpl/6_question.yml
@@ -1,5 +1,5 @@
name: Ask question
-description: Ask yt-dlp related question
+description: Ask a question about using yt-dlp
labels: [question]
body:
%(no_skip)s
@@ -22,9 +22,7 @@ body:
required: true
- 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))
required: true
- - 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 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)
+ - label: I've searched [known issues](https://github.com/yt-dlp/yt-dlp/issues/3766), [the FAQ](https://github.com/yt-dlp/yt-dlp/wiki/FAQ), and the [bugtracker](https://github.com/yt-dlp/yt-dlp/issues?q=is%%3Aissue%%20-label%%3Aspam%%20%%20) for similar questions **including closed ones**. DO NOT post duplicates
required: true
- type: textarea
id: question
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 4deee572f..4dcfcc48c 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,14 +1,17 @@
-**IMPORTANT**: PRs without the template will be CLOSED
+<!--
+ **IMPORTANT**: PRs without the template will be CLOSED
+
+ Due to the high volume of pull requests, it may be a while before your PR is reviewed.
+ Please try to keep your pull request focused on a single bugfix or new feature.
+ Pull requests with a vast scope and/or very large diff will take much longer to review.
+ It is recommended for new contributors to stick to smaller pull requests, so you can receive much more immediate feedback as you familiarize yourself with the codebase.
+
+ PLEASE AVOID FORCE-PUSHING after opening a PR, as it makes reviewing more difficult.
+-->
### Description of your *pull request* and other information
-<!--
-
-Explanation of your *pull request* in arbitrary form goes here. Please **make sure the description explains the purpose and effect** of your *pull request* and is worded well enough to be understood. Provide as much **context and examples** as possible
-
--->
-
-ADD DESCRIPTION HERE
+ADD DETAILED DESCRIPTION HERE
Fixes #
@@ -16,24 +19,22 @@ Fixes #
<details open><summary>Template</summary> <!-- OPEN is intentional -->
<!--
+ # PLEASE FOLLOW THE GUIDE BELOW
-# PLEASE FOLLOW THE GUIDE BELOW
-
-- You will be asked some questions, please read them **carefully** and answer honestly
-- Put an `x` into all the boxes `[ ]` relevant to your *pull request* (like [x])
-- Use *Preview* tab to see how your *pull request* will actually look like
-
+ - You will be asked some questions, please read them **carefully** and answer honestly
+ - Put an `x` into all the boxes `[ ]` relevant to your *pull request* (like [x])
+ - Use *Preview* tab to see what your *pull request* will actually look like
-->
### Before submitting a *pull request* make sure you have:
- [ ] At least skimmed through [contributing guidelines](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#developer-instructions) including [yt-dlp coding conventions](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#yt-dlp-coding-conventions)
- [ ] [Searched](https://github.com/yt-dlp/yt-dlp/search?q=is%3Apr&type=Issues) the bugtracker for similar pull requests
-### In order to be accepted and merged into yt-dlp each piece of code must be in public domain or released under [Unlicense](http://unlicense.org/). Check all of the following options that apply:
-- [ ] I am the original author of this code and I am willing to release it under [Unlicense](http://unlicense.org/)
-- [ ] I am not the original author of this code but it is in public domain or released under [Unlicense](http://unlicense.org/) (provide reliable evidence)
+### In order to be accepted and merged into yt-dlp each piece of code must be in public domain or released under [Unlicense](http://unlicense.org/). Check those that apply and remove the others:
+- [ ] I am the original author of the code in this PR, and I am willing to release it under [Unlicense](http://unlicense.org/)
+- [ ] I am not the original author of the code in this PR, but it is in the public domain or released under [Unlicense](http://unlicense.org/) (provide reliable evidence)
-### What is the purpose of your *pull request*?
+### What is the purpose of your *pull request*? Check those that apply and remove the others:
- [ ] Fix or improvement to an extractor (Make sure to add/update tests)
- [ ] New extractor ([Piracy websites will not be accepted](https://github.com/yt-dlp/yt-dlp/blob/master/CONTRIBUTING.md#is-the-website-primarily-used-for-piracy))
- [ ] Core bug fix/improvement
diff --git a/README.md b/README.md
index 45c56434a..0ac27c462 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,6 @@
[](#installation "Installation")
[](https://pypi.org/project/yt-dlp "PyPI")
[](Collaborators.md#collaborators "Donate")
-[](https://matrix.to/#/#yt-dlp:matrix.org "Matrix")
[](https://discord.gg/H5MNcFW63r "Discord")
[](supportedsites.md "Supported Sites")
[](LICENSE "License")
diff --git a/devscripts/make_issue_template.py b/devscripts/make_issue_template.py
index 2a418ddbf..681ebc51c 100644
--- a/devscripts/make_issue_template.py
+++ b/devscripts/make_issue_template.py
@@ -11,11 +11,13 @@ import re
from devscripts.utils import get_filename_args, read_file, write_file
-VERBOSE_TMPL = '''
+VERBOSE = '''
- type: checkboxes
id: verbose
attributes:
label: Provide verbose output that clearly demonstrates the problem
+ description: |
+ This is mandatory unless absolutely impossible to provide. If you are unable to provide the output, please explain why.
options:
- label: Run **your** yt-dlp command with **-vU** flag added (`yt-dlp -vU <your command line>`)
required: true
@@ -47,31 +49,23 @@ VERBOSE_TMPL = '''
render: shell
validations:
required: true
- - type: markdown
- attributes:
- value: |
- > [!CAUTION]
- > ### GitHub is experiencing a high volume of malicious spam comments.
- > ### If you receive any replies asking you download a file, do NOT follow the download links!
- >
- > Note that this issue may be temporarily locked as an anti-spam measure after it is opened.
'''.strip()
NO_SKIP = '''
- - type: checkboxes
+ - type: markdown
attributes:
- label: DO NOT REMOVE OR SKIP THE ISSUE TEMPLATE
- description: Fill all fields even if you think it is irrelevant for the issue
- options:
- - label: I understand that I will be **blocked** if I *intentionally* remove or skip any mandatory\\* field
- required: true
+ value: |
+ > [!IMPORTANT]
+ > Not providing the required (*) information will result in your issue being closed and ignored.
'''.strip()
def main():
- fields = {'no_skip': NO_SKIP}
- fields['verbose'] = VERBOSE_TMPL % fields
- fields['verbose_optional'] = re.sub(r'(\n\s+validations:)?\n\s+required: true', '', fields['verbose'])
+ fields = {
+ 'no_skip': NO_SKIP,
+ 'verbose': VERBOSE,
+ 'verbose_optional': re.sub(r'(\n\s+validations:)?\n\s+required: true', '', VERBOSE),
+ }
infile, outfile = get_filename_args(has_infile=True)
write_file(outfile, read_file(infile) % fields)