From 60bf14d3e95b0f70a831e32aa8f49d572ae66ffa Mon Sep 17 00:00:00 2001 From: Sander van den Oever Date: Sun, 6 Mar 2016 23:16:13 +0100 Subject: [PATCH 1/7] Add an issue template --- ISSUE_TEMPLATE.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 ISSUE_TEMPLATE.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..366a0834c --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,28 @@ +**Kind of issue** +- [ ] Site request (add support for a new website) +- [ ] Feature request (request new functionality) +- [ ] Bug report (encountered problems with youtube-dl) +- [ ] Other, namely ... + +**Brief description of the problem/request** + +*I am having a problem with ... I have tried to do ... and ... I expected that ... would happen, but instead ... happened. Example: I tried to download a file but the site was not supported. Please add support for site xyz. Another example: I encountered a bug when downloading a video from xyz. I have tried to do a and b.* + +**Suggested solution or other information** + +*In case you have suggestions for a solution or any other relevant information you can write it here* + +**Example URL** + +*Provide the url of the file that you were trying to download.* + +**Output of running youtube-dl with `--verbose` or `-v`** +``` +Replace the contents between the backticks (`) with the output of youtube-dl when running with the --verbose or -v flag. +``` + +**Output of running `youtube-dl --version`** +``` +Replace the contents between the backticks (`) with the output of 'youtube-dl --version'. +Make sure you are using the latest version by running 'youtube-dl --update' +``` From f8481d79d51f42724c653b863cd3a69a676446d3 Mon Sep 17 00:00:00 2001 From: Sander van den Oever Date: Tue, 8 Mar 2016 15:01:41 +0100 Subject: [PATCH 2/7] Add auto-updating of youtube-dl version in ISSUE_TEMPLATE --- ISSUE_TEMPLATE.md | 11 ++++------- Makefile | 5 ++++- devscripts/make_issue_template.py | 32 +++++++++++++++++++++++++++++++ 3 files changed, 40 insertions(+), 8 deletions(-) create mode 100644 devscripts/make_issue_template.py diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 366a0834c..e9f4caa7e 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -4,6 +4,9 @@ - [ ] Bug report (encountered problems with youtube-dl) - [ ] Other, namely ... +**Run `youtube-dl --version` to check whether you have the latest version** +- [ ] I've verified that I'm running the latest version available (2016.03.06) + **Brief description of the problem/request** *I am having a problem with ... I have tried to do ... and ... I expected that ... would happen, but instead ... happened. Example: I tried to download a file but the site was not supported. Please add support for site xyz. Another example: I encountered a bug when downloading a video from xyz. I have tried to do a and b.* @@ -19,10 +22,4 @@ **Output of running youtube-dl with `--verbose` or `-v`** ``` Replace the contents between the backticks (`) with the output of youtube-dl when running with the --verbose or -v flag. -``` - -**Output of running `youtube-dl --version`** -``` -Replace the contents between the backticks (`) with the output of 'youtube-dl --version'. -Make sure you are using the latest version by running 'youtube-dl --update' -``` +``` \ No newline at end of file diff --git a/Makefile b/Makefile index e98806791..dabb58760 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -all: youtube-dl README.md CONTRIBUTING.md README.txt youtube-dl.1 youtube-dl.bash-completion youtube-dl.zsh youtube-dl.fish supportedsites +all: youtube-dl README.md CONTRIBUTING.md issue_template README.txt youtube-dl.1 youtube-dl.bash-completion youtube-dl.zsh youtube-dl.fish supportedsites clean: rm -rf youtube-dl.1.temp.md youtube-dl.1 youtube-dl.bash-completion README.txt MANIFEST build/ dist/ .coverage cover/ youtube-dl.tar.gz youtube-dl.zsh youtube-dl.fish *.dump *.part *.info.json *.mp4 *.flv *.mp3 *.avi CONTRIBUTING.md.tmp youtube-dl youtube-dl.exe @@ -67,6 +67,9 @@ README.md: youtube_dl/*.py youtube_dl/*/*.py CONTRIBUTING.md: README.md $(PYTHON) devscripts/make_contributing.py README.md CONTRIBUTING.md +issue_template: ISSUE_TEMPLATE.md youtube_dl/version.py + $(PYTHON) devscripts/make_issue_template.py ISSUE_TEMPLATE.md + supportedsites: $(PYTHON) devscripts/make_supportedsites.py docs/supportedsites.md diff --git a/devscripts/make_issue_template.py b/devscripts/make_issue_template.py new file mode 100644 index 000000000..137c83532 --- /dev/null +++ b/devscripts/make_issue_template.py @@ -0,0 +1,32 @@ +#!/usr/bin/env python +from __future__ import unicode_literals + +import io +import optparse +import re + + +def main(): + parser = optparse.OptionParser(usage='%prog FILE') + options, args = parser.parse_args() + if len(args) != 1: + parser.error('Expected an filename') + + with io.open(args[0], encoding='utf-8') as inf: + issue_template_text = inf.read() + + # Get the version from youtube_dl/version.py without importing the package + exec(compile(open('youtube_dl/version.py').read(), + 'youtube_dl/version.py', 'exec')) + + issue_template_text = re.sub( + r'(?<=available \()(?P[0-9\.]+)(?=\))', + __version__, + issue_template_text + ) + + with io.open(args[0], 'w', encoding='utf-8') as outf: + outf.write(issue_template_text) + +if __name__ == '__main__': + main() From aab1f6bc96c470a334b1dea51f6c2a5d2f34ecac Mon Sep 17 00:00:00 2001 From: Sander van den Oever Date: Fri, 11 Mar 2016 21:52:56 +0100 Subject: [PATCH 3/7] Move parts of template text and adopt makefile to new format --- ISSUE_TEMPLATE.md | 28 ++++++++++++++++++++-------- devscripts/make_issue_template.py | 2 +- 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index e9f4caa7e..30a10ec2c 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,12 +1,29 @@ +Make sure you are using the **latest** version of youtube-dl. Latest youtube-dl version at this moment is **2016.03.06**. Read [our FAQ](https://github.com/rg3/youtube-dl/blob/master/README.md#how-do-i-update-youtube-dl) if you have troubles updating. +- [ ] I've verified that I'm running youtube-dl version **2016.03.06** + +*The log (next question) is not required when asking a question or when the purpose of this issue does not imply the need of a log* + +**Please include the full output of youtube-dl when run with `-v`**, i.e. **add** `-v` flag to **your command line**, copy the **whole** output and post it below wrapped in ``` for better formatting. It should look similar to this: +``` +$ youtube-dl -v +[debug] System config: [] +[debug] User config: [] +[debug] Command-line args: [u'-v', u'http://www.youtube.com/watch?v=BaW_jenozKcj'] +[debug] Encodings: locale cp1251, fs mbcs, out cp866, pref cp1251 +[debug] youtube-dl version 2015.12.06 +[debug] Git HEAD: 135392e +[debug] Python version 2.6.6 - Windows-2003Server-5.2.3790-SP2 +[debug] exe versions: ffmpeg N-75573-g1d0487f, ffprobe N-75573-g1d0487f, rtmpdump 2.4 +[debug] Proxy map: {} +... +``` + **Kind of issue** - [ ] Site request (add support for a new website) - [ ] Feature request (request new functionality) - [ ] Bug report (encountered problems with youtube-dl) - [ ] Other, namely ... -**Run `youtube-dl --version` to check whether you have the latest version** -- [ ] I've verified that I'm running the latest version available (2016.03.06) - **Brief description of the problem/request** *I am having a problem with ... I have tried to do ... and ... I expected that ... would happen, but instead ... happened. Example: I tried to download a file but the site was not supported. Please add support for site xyz. Another example: I encountered a bug when downloading a video from xyz. I have tried to do a and b.* @@ -18,8 +35,3 @@ **Example URL** *Provide the url of the file that you were trying to download.* - -**Output of running youtube-dl with `--verbose` or `-v`** -``` -Replace the contents between the backticks (`) with the output of youtube-dl when running with the --verbose or -v flag. -``` \ No newline at end of file diff --git a/devscripts/make_issue_template.py b/devscripts/make_issue_template.py index 137c83532..2fdd05035 100644 --- a/devscripts/make_issue_template.py +++ b/devscripts/make_issue_template.py @@ -20,7 +20,7 @@ def main(): 'youtube_dl/version.py', 'exec')) issue_template_text = re.sub( - r'(?<=available \()(?P[0-9\.]+)(?=\))', + r'(?<=\*\*)(?P[0-9\.]+)(?=\*\*)', __version__, issue_template_text ) From 13db5efe30ab85da82ce218b4d0a21cf39011e6e Mon Sep 17 00:00:00 2001 From: Sander van den Oever Date: Sat, 12 Mar 2016 23:33:05 +0100 Subject: [PATCH 4/7] Moved the 'kind-of-issue' section and rephrased a bit --- ISSUE_TEMPLATE.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 30a10ec2c..98230258b 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,7 +1,13 @@ Make sure you are using the **latest** version of youtube-dl. Latest youtube-dl version at this moment is **2016.03.06**. Read [our FAQ](https://github.com/rg3/youtube-dl/blob/master/README.md#how-do-i-update-youtube-dl) if you have troubles updating. - [ ] I've verified that I'm running youtube-dl version **2016.03.06** -*The log (next question) is not required when asking a question or when the purpose of this issue does not imply the need of a log* +**What is the purpose of this issue? Put an `x` to the relevant box** +- [ ] Site request (add support for a new website) +- [ ] Feature request (request new functionality) +- [ ] Bug report (encountered problems with youtube-dl) +- [ ] Other, namely ... + +*If the purpose of this issue is a site request, bug report or you are unsure about its relevance please include a log as described below.* **Please include the full output of youtube-dl when run with `-v`**, i.e. **add** `-v` flag to **your command line**, copy the **whole** output and post it below wrapped in ``` for better formatting. It should look similar to this: ``` @@ -18,12 +24,6 @@ $ youtube-dl -v ... ``` -**Kind of issue** -- [ ] Site request (add support for a new website) -- [ ] Feature request (request new functionality) -- [ ] Bug report (encountered problems with youtube-dl) -- [ ] Other, namely ... - **Brief description of the problem/request** *I am having a problem with ... I have tried to do ... and ... I expected that ... would happen, but instead ... happened. Example: I tried to download a file but the site was not supported. Please add support for site xyz. Another example: I encountered a bug when downloading a video from xyz. I have tried to do a and b.* From a288720d63593b4ed512a23eb8dfb49b5bd8a4f5 Mon Sep 17 00:00:00 2001 From: Sander van den Oever Date: Sat, 12 Mar 2016 23:58:15 +0100 Subject: [PATCH 5/7] Rephrased and moved Example URL section upwards --- ISSUE_TEMPLATE.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 98230258b..c34cbe743 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -2,12 +2,16 @@ Make sure you are using the **latest** version of youtube-dl. Latest youtube-dl - [ ] I've verified that I'm running youtube-dl version **2016.03.06** **What is the purpose of this issue? Put an `x` to the relevant box** -- [ ] Site request (add support for a new website) +- [ ] Site support request (add support for a new website) - [ ] Feature request (request new functionality) - [ ] Bug report (encountered problems with youtube-dl) - [ ] Other, namely ... -*If the purpose of this issue is a site request, bug report or you are unsure about its relevance please include a log as described below.* +**If the purpose of this issues is a site support request please provide _at least_ one example URL of a video or a playlist you are trying to download.** + +- http://some.example.url/to-video + +*If the purpose of this issue is a bug report or you are unsure about its relevance please include a log as described below.* **Please include the full output of youtube-dl when run with `-v`**, i.e. **add** `-v` flag to **your command line**, copy the **whole** output and post it below wrapped in ``` for better formatting. It should look similar to this: ``` @@ -31,7 +35,3 @@ $ youtube-dl -v **Suggested solution or other information** *In case you have suggestions for a solution or any other relevant information you can write it here* - -**Example URL** - -*Provide the url of the file that you were trying to download.* From e743d49a8b466784febab00c4a5e36efdc17dc8c Mon Sep 17 00:00:00 2001 From: Sander van den Oever Date: Mon, 14 Mar 2016 23:43:12 +0100 Subject: [PATCH 6/7] Moved ISSUE_TEMPLATE inside .github folder. --- ISSUE_TEMPLATE.md => .github/ISSUE_TEMPLATE.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename ISSUE_TEMPLATE.md => .github/ISSUE_TEMPLATE.md (100%) diff --git a/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md similarity index 100% rename from ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE.md From e82b1ed2eb25c9c1882592b549883ca671d97927 Mon Sep 17 00:00:00 2001 From: Sander van den Oever Date: Mon, 14 Mar 2016 23:56:34 +0100 Subject: [PATCH 7/7] Update makefile to match new folderstructure --- Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index dabb58760..3e3c5307f 100644 --- a/Makefile +++ b/Makefile @@ -67,8 +67,8 @@ README.md: youtube_dl/*.py youtube_dl/*/*.py CONTRIBUTING.md: README.md $(PYTHON) devscripts/make_contributing.py README.md CONTRIBUTING.md -issue_template: ISSUE_TEMPLATE.md youtube_dl/version.py - $(PYTHON) devscripts/make_issue_template.py ISSUE_TEMPLATE.md +issue_template: .github/ISSUE_TEMPLATE.md youtube_dl/version.py + $(PYTHON) devscripts/make_issue_template.py .github/ISSUE_TEMPLATE.md supportedsites: $(PYTHON) devscripts/make_supportedsites.py docs/supportedsites.md