From 5d061eadc7be50e663d9024fbc70ca8507ff59a2 Mon Sep 17 00:00:00 2001 From: Nathan Thomas Date: Wed, 15 Sep 2021 21:08:42 -0700 Subject: [PATCH 01/17] Merge new bug report template --- .github/ISSUE_TEMPLATE/bug_report.yaml | 106 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yaml | 1 + 2 files changed, 107 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..2bd07ac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,106 @@ +name: Bug report +description: Create a report to help us improve streamrip +labels: bug +body: + # types: dropdown, textarea, input + # - type: dropdown + # validations: + # required: true + # attributes: + # label: Are you using "tree-sitter" branch? + # options: + # - 'Yes' + # - 'No' + + - type: textarea + validations: + required: true + attributes: + label: Describe the bug + description: A clear and concise description of the bug. + + - type: textarea + validations: + required: true + attributes: + label: Command Used + description: | + The command that you typed that caused the error + placeholder: | + For example: + `rip url https://example.com` + + - type: markdown + attributes: + value: "```\n" + + - type: textarea + validations: + required: true + attributes: + label: Debug Traceback + description: | + Run your command, with `-vvv` appended to it, and paste the output here. + For example, if the problematic command was `rip url https://example.com`, then + you would run `rip url https://example.com -vvv` to get the debug logs. + Make sure to check the logs for any personal information such as emails and remove them. + + - type: markdown + attributes: + value: "```" + + - type: markdown + attributes: + value: "```toml\n" + + - type: textarea + validations: + required: true + attributes: + label: Config File + description: | + Find the config file using `rip config --open` and paste the contents here. + Make sure you REMOVE YOUR CREDENTIALS! + + - type: markdown + attributes: + value: "```" + + - type: input + validations: + required: true + attributes: + label: Operating System + placeholder: e.g. Windows, Linux, macOS... + + - type: markdown + attributes: + value: "```\n" + + - type: input + validations: + required: true + attributes: + label: streamrip version + description: Run `rip --version` to check. + placeholder: e.g. 1.5 + + - type: markdown + attributes: + value: "```" + + - type: textarea + attributes: + label: Screenshots and recordings + description: | + If applicable, add screenshots to help explain your problem. + You can also record an asciinema session: https://asciinema.org/ + + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. + + - type: markdown + attributes: + value: "Thanks for completing our form!" diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1 @@ +blank_issues_enabled: false From 3db178af3b8cf658db48968da87d08429cf4a7cf Mon Sep 17 00:00:00 2001 From: Nathan Thomas Date: Wed, 15 Sep 2021 21:17:51 -0700 Subject: [PATCH 02/17] Update issue template --- .github/ISSUE_TEMPLATE/bug_report.yaml | 27 +++----------------------- 1 file changed, 3 insertions(+), 24 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 2bd07ac..5742474 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -29,10 +29,7 @@ body: placeholder: | For example: `rip url https://example.com` - - - type: markdown - attributes: - value: "```\n" + render: "" - type: textarea validations: @@ -44,14 +41,7 @@ body: For example, if the problematic command was `rip url https://example.com`, then you would run `rip url https://example.com -vvv` to get the debug logs. Make sure to check the logs for any personal information such as emails and remove them. - - - type: markdown - attributes: - value: "```" - - - type: markdown - attributes: - value: "```toml\n" + render: "" - type: textarea validations: @@ -61,10 +51,7 @@ body: description: | Find the config file using `rip config --open` and paste the contents here. Make sure you REMOVE YOUR CREDENTIALS! - - - type: markdown - attributes: - value: "```" + render: toml - type: input validations: @@ -73,10 +60,6 @@ body: label: Operating System placeholder: e.g. Windows, Linux, macOS... - - type: markdown - attributes: - value: "```\n" - - type: input validations: required: true @@ -85,10 +68,6 @@ body: description: Run `rip --version` to check. placeholder: e.g. 1.5 - - type: markdown - attributes: - value: "```" - - type: textarea attributes: label: Screenshots and recordings From e651ac4b59d37db7dc50e2c8953f0977a0031eea Mon Sep 17 00:00:00 2001 From: Nathan Thomas Date: Wed, 15 Sep 2021 21:21:10 -0700 Subject: [PATCH 03/17] Update issue template --- .github/ISSUE_TEMPLATE/bug_report.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 5742474..1201d87 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -29,7 +29,7 @@ body: placeholder: | For example: `rip url https://example.com` - render: "" + render: "bash" - type: textarea validations: @@ -41,7 +41,7 @@ body: For example, if the problematic command was `rip url https://example.com`, then you would run `rip url https://example.com -vvv` to get the debug logs. Make sure to check the logs for any personal information such as emails and remove them. - render: "" + render: "text" - type: textarea validations: From 04579d828941fb43f419b77141496e397d65da91 Mon Sep 17 00:00:00 2001 From: Nathan Thomas Date: Wed, 15 Sep 2021 21:30:02 -0700 Subject: [PATCH 04/17] Update issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 58 --------------------- .github/ISSUE_TEMPLATE/bug_report.yaml | 1 + .github/ISSUE_TEMPLATE/feature_request.yaml | 22 ++++++++ 3 files changed, 23 insertions(+), 58 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index c813ad3..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -name: "\U0001F41B Bug Report" -about: "If something isn't working as expected \U0001F914." -title: 'Bug: Your Title' -labels: bug -assignees: nathom - ---- - -## Bug Report - -**Current Behavior** -A clear and concise description of the behavior. - -**Command used:** - -```bash -Type the command that caused the bug here -``` - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**`streamrip` Configuration File (find using `rip config -o`):** - - - - - - - - - - -```toml -# Paste the contents of config.toml here -# REMOVE YOUR CREDENTIALS -[your] -config = "file" -``` - -**Environment** - -- `streamrip` version(s): [e.g. v0.5.2] -- Python version: [e.g. 3.8] -- OS: [e.g. OSX 10.13.4, Windows 10] - -**Traceback** -```bash -# Paste the text that Python dumped on the error here -# Delete this section if there was no traceback -``` - -**Possible Solution** - - -**Additional context/Screenshots** -Add any other context about the problem here. If applicable, add screenshots to help explain. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 1201d87..bd85919 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -67,6 +67,7 @@ body: label: streamrip version description: Run `rip --version` to check. placeholder: e.g. 1.5 + render: "text" - type: textarea attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..0e357ea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,22 @@ +name: Feature Request +description: Suggest a feature that would improve streamrip +labels: enhancement +body: + - type: textarea + validations: + required: true + attributes: + label: Is the feature request related to a problem. Please describe it. + description: e.g. I have an issue when... + + - type: textarea + validations: + required: true + attributes: + label: Describe the solution you would like. + description: A clear and concise description of what you want to happen. Add any considered drawbacks. + + - type: textarea + attributes: + label: Describe alternatives you've considered. + description: A clear and concise description of any alternative solutions or features you've considered. From b92e75611789570b9bc35701b61423eb47f4aa84 Mon Sep 17 00:00:00 2001 From: Nathan Thomas Date: Wed, 15 Sep 2021 21:36:17 -0700 Subject: [PATCH 05/17] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.yaml | 3 ++- .github/ISSUE_TEMPLATE/{config.yaml => config.yml} | 0 .github/ISSUE_TEMPLATE/feature_request.yaml | 3 ++- 3 files changed, 4 insertions(+), 2 deletions(-) rename .github/ISSUE_TEMPLATE/{config.yaml => config.yml} (100%) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index bd85919..b051399 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -1,6 +1,7 @@ -name: Bug report +name: 🐛 Bug Report description: Create a report to help us improve streamrip labels: bug +title: "[BUG] " body: # types: dropdown, textarea, input # - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yml similarity index 100% rename from .github/ISSUE_TEMPLATE/config.yaml rename to .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 0e357ea..f9e66c0 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -1,6 +1,7 @@ -name: Feature Request +name: 🚀 Feature Request description: Suggest a feature that would improve streamrip labels: enhancement +title: "[FEATURE] <title>" body: - type: textarea validations: From 6a0f2e22b7a9ab7d21a65e41ecca26dae18fd0b3 Mon Sep 17 00:00:00 2001 From: Nathan Thomas <nathanthomas707@gmail.com> Date: Wed, 15 Sep 2021 21:37:05 -0700 Subject: [PATCH 06/17] Remove old feature request template --- .github/ISSUE_TEMPLATE/feature_request.md | 19 ------------------- 1 file changed, 19 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 807c7d9..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: "\U0001F680 Feature Request" -about: "I have a suggestion (and may want to implement it \U0001F642)!" -title: 'Feature Request: ' -labels: enhancement -assignees: '' - ---- - -## Feature Request - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I have an issue when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. Add any considered drawbacks. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. From 579ffefb844586813cf6f537a3c96f9a763d3e77 Mon Sep 17 00:00:00 2001 From: Nathan Thomas <nathanthomas707@gmail.com> Date: Wed, 15 Sep 2021 21:38:20 -0700 Subject: [PATCH 07/17] Change yaml extension to yml --- .github/ISSUE_TEMPLATE/bug_report.yaml | 87 --------------------- .github/ISSUE_TEMPLATE/feature_request.yaml | 23 ------ 2 files changed, 110 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml deleted file mode 100644 index b051399..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ /dev/null @@ -1,87 +0,0 @@ -name: 🐛 Bug Report -description: Create a report to help us improve streamrip -labels: bug -title: "[BUG] <title>" -body: - # types: dropdown, textarea, input - # - type: dropdown - # validations: - # required: true - # attributes: - # label: Are you using "tree-sitter" branch? - # options: - # - 'Yes' - # - 'No' - - - type: textarea - validations: - required: true - attributes: - label: Describe the bug - description: A clear and concise description of the bug. - - - type: textarea - validations: - required: true - attributes: - label: Command Used - description: | - The command that you typed that caused the error - placeholder: | - For example: - `rip url https://example.com` - render: "bash" - - - type: textarea - validations: - required: true - attributes: - label: Debug Traceback - description: | - Run your command, with `-vvv` appended to it, and paste the output here. - For example, if the problematic command was `rip url https://example.com`, then - you would run `rip url https://example.com -vvv` to get the debug logs. - Make sure to check the logs for any personal information such as emails and remove them. - render: "text" - - - type: textarea - validations: - required: true - attributes: - label: Config File - description: | - Find the config file using `rip config --open` and paste the contents here. - Make sure you REMOVE YOUR CREDENTIALS! - render: toml - - - type: input - validations: - required: true - attributes: - label: Operating System - placeholder: e.g. Windows, Linux, macOS... - - - type: input - validations: - required: true - attributes: - label: streamrip version - description: Run `rip --version` to check. - placeholder: e.g. 1.5 - render: "text" - - - type: textarea - attributes: - label: Screenshots and recordings - description: | - If applicable, add screenshots to help explain your problem. - You can also record an asciinema session: https://asciinema.org/ - - - type: textarea - attributes: - label: Additional context - description: Add any other context about the problem here. - - - type: markdown - attributes: - value: "Thanks for completing our form!" diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml deleted file mode 100644 index f9e66c0..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ /dev/null @@ -1,23 +0,0 @@ -name: 🚀 Feature Request -description: Suggest a feature that would improve streamrip -labels: enhancement -title: "[FEATURE] <title>" -body: - - type: textarea - validations: - required: true - attributes: - label: Is the feature request related to a problem. Please describe it. - description: e.g. I have an issue when... - - - type: textarea - validations: - required: true - attributes: - label: Describe the solution you would like. - description: A clear and concise description of what you want to happen. Add any considered drawbacks. - - - type: textarea - attributes: - label: Describe alternatives you've considered. - description: A clear and concise description of any alternative solutions or features you've considered. From e58250f033c0c340075d66f7b82115ae33cb5e69 Mon Sep 17 00:00:00 2001 From: Nathan Thomas <nathanthomas707@gmail.com> Date: Wed, 15 Sep 2021 21:39:16 -0700 Subject: [PATCH 08/17] Add updated issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 87 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 23 ++++++ 2 files changed, 110 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..b051399 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,87 @@ +name: 🐛 Bug Report +description: Create a report to help us improve streamrip +labels: bug +title: "[BUG] <title>" +body: + # types: dropdown, textarea, input + # - type: dropdown + # validations: + # required: true + # attributes: + # label: Are you using "tree-sitter" branch? + # options: + # - 'Yes' + # - 'No' + + - type: textarea + validations: + required: true + attributes: + label: Describe the bug + description: A clear and concise description of the bug. + + - type: textarea + validations: + required: true + attributes: + label: Command Used + description: | + The command that you typed that caused the error + placeholder: | + For example: + `rip url https://example.com` + render: "bash" + + - type: textarea + validations: + required: true + attributes: + label: Debug Traceback + description: | + Run your command, with `-vvv` appended to it, and paste the output here. + For example, if the problematic command was `rip url https://example.com`, then + you would run `rip url https://example.com -vvv` to get the debug logs. + Make sure to check the logs for any personal information such as emails and remove them. + render: "text" + + - type: textarea + validations: + required: true + attributes: + label: Config File + description: | + Find the config file using `rip config --open` and paste the contents here. + Make sure you REMOVE YOUR CREDENTIALS! + render: toml + + - type: input + validations: + required: true + attributes: + label: Operating System + placeholder: e.g. Windows, Linux, macOS... + + - type: input + validations: + required: true + attributes: + label: streamrip version + description: Run `rip --version` to check. + placeholder: e.g. 1.5 + render: "text" + + - type: textarea + attributes: + label: Screenshots and recordings + description: | + If applicable, add screenshots to help explain your problem. + You can also record an asciinema session: https://asciinema.org/ + + - type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. + + - type: markdown + attributes: + value: "Thanks for completing our form!" diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..f9e66c0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,23 @@ +name: 🚀 Feature Request +description: Suggest a feature that would improve streamrip +labels: enhancement +title: "[FEATURE] <title>" +body: + - type: textarea + validations: + required: true + attributes: + label: Is the feature request related to a problem. Please describe it. + description: e.g. I have an issue when... + + - type: textarea + validations: + required: true + attributes: + label: Describe the solution you would like. + description: A clear and concise description of what you want to happen. Add any considered drawbacks. + + - type: textarea + attributes: + label: Describe alternatives you've considered. + description: A clear and concise description of any alternative solutions or features you've considered. From 2c129cccd0ff41e69d50c64fb5070732e3cb89a7 Mon Sep 17 00:00:00 2001 From: Nathan Thomas <nathanthomas707@gmail.com> Date: Wed, 15 Sep 2021 21:40:41 -0700 Subject: [PATCH 09/17] Remove render key from input field --- .github/ISSUE_TEMPLATE/bug_report.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index b051399..9736278 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -68,7 +68,6 @@ body: label: streamrip version description: Run `rip --version` to check. placeholder: e.g. 1.5 - render: "text" - type: textarea attributes: From c4f25e8bd6dcaf248a2c5ad7b8c22ddec65fb238 Mon Sep 17 00:00:00 2001 From: Nathan Thomas <nathanthomas707@gmail.com> Date: Wed, 15 Sep 2021 21:47:01 -0700 Subject: [PATCH 10/17] Improve placeholders --- .github/ISSUE_TEMPLATE/bug_report.yml | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 9736278..2fbc5bd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -27,9 +27,7 @@ body: label: Command Used description: | The command that you typed that caused the error - placeholder: | - For example: - `rip url https://example.com` + placeholder: e.g. rip url https://example.com render: "bash" - type: textarea @@ -43,6 +41,10 @@ body: you would run `rip url https://example.com -vvv` to get the debug logs. Make sure to check the logs for any personal information such as emails and remove them. render: "text" + placeholder: | + DEBUG:streamrip:Config loaded + DEBUG:streamrip:Config saved: /Users/username/Library/Application Support/streamrip/config.toml + ... - type: textarea validations: @@ -53,6 +55,13 @@ body: Find the config file using `rip config --open` and paste the contents here. Make sure you REMOVE YOUR CREDENTIALS! render: toml + placeholder: | + [downloads] + # Folder where tracks are downloaded to + folder = "/Users/username/StreamripDownloads" + # Put Qobuz albums in a 'Qobuz' folder, Tidal albums in 'Tidal' etc. + source_subdirectories = false + ... - type: input validations: From 4af391222159ab7c734b306c3036a6fad12c415b Mon Sep 17 00:00:00 2001 From: Nathan Thomas <nathanthomas707@gmail.com> Date: Wed, 15 Sep 2021 21:50:36 -0700 Subject: [PATCH 11/17] Fix formatting in placeholders --- .github/ISSUE_TEMPLATE/bug_report.yml | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 2fbc5bd..6306c5e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -41,10 +41,11 @@ body: you would run `rip url https://example.com -vvv` to get the debug logs. Make sure to check the logs for any personal information such as emails and remove them. render: "text" - placeholder: | - DEBUG:streamrip:Config loaded + placeholder: "DEBUG:streamrip:Config loaded + DEBUG:streamrip:Config saved: /Users/username/Library/Application Support/streamrip/config.toml - ... + + ..." - type: textarea validations: @@ -55,13 +56,17 @@ body: Find the config file using `rip config --open` and paste the contents here. Make sure you REMOVE YOUR CREDENTIALS! render: toml - placeholder: | - [downloads] + placeholder: '[downloads] + # Folder where tracks are downloaded to + folder = "/Users/username/StreamripDownloads" - # Put Qobuz albums in a 'Qobuz' folder, Tidal albums in 'Tidal' etc. + + # Put Qobuz albums in a ''Qobuz'' folder, Tidal albums in ''Tidal'' etc. + source_subdirectories = false - ... + + ...' - type: input validations: From d2344eaa1994e97810e47737eff5c9fe96716a99 Mon Sep 17 00:00:00 2001 From: Nathan Thomas <nathanthomas707@gmail.com> Date: Wed, 15 Sep 2021 21:52:51 -0700 Subject: [PATCH 12/17] Remove multiline placeholder text --- .github/ISSUE_TEMPLATE/bug_report.yml | 18 ++---------------- 1 file changed, 2 insertions(+), 16 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 6306c5e..c3da151 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -41,11 +41,7 @@ body: you would run `rip url https://example.com -vvv` to get the debug logs. Make sure to check the logs for any personal information such as emails and remove them. render: "text" - placeholder: "DEBUG:streamrip:Config loaded - - DEBUG:streamrip:Config saved: /Users/username/Library/Application Support/streamrip/config.toml - - ..." + placeholder: "DEBUG:streamrip:Config loaded..." - type: textarea validations: @@ -56,17 +52,7 @@ body: Find the config file using `rip config --open` and paste the contents here. Make sure you REMOVE YOUR CREDENTIALS! render: toml - placeholder: '[downloads] - - # Folder where tracks are downloaded to - - folder = "/Users/username/StreamripDownloads" - - # Put Qobuz albums in a ''Qobuz'' folder, Tidal albums in ''Tidal'' etc. - - source_subdirectories = false - - ...' + placeholder: "[downloads]\n..." - type: input validations: From 24c92326fa842ec6fb5830620199bb7b2d345b8d Mon Sep 17 00:00:00 2001 From: Nathan Thomas <nathanthomas707@gmail.com> Date: Wed, 15 Sep 2021 21:54:11 -0700 Subject: [PATCH 13/17] Improve placeholders --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index c3da151..86583a5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -41,7 +41,7 @@ body: you would run `rip url https://example.com -vvv` to get the debug logs. Make sure to check the logs for any personal information such as emails and remove them. render: "text" - placeholder: "DEBUG:streamrip:Config loaded..." + placeholder: Logs printed to terminal screen - type: textarea validations: @@ -52,7 +52,7 @@ body: Find the config file using `rip config --open` and paste the contents here. Make sure you REMOVE YOUR CREDENTIALS! render: toml - placeholder: "[downloads]\n..." + placeholder: Contents of config.toml - type: input validations: From 908ed627bce81cac6cb9840a409b77577fff040f Mon Sep 17 00:00:00 2001 From: Nathan Thomas <nathanthomas707@gmail.com> Date: Wed, 15 Sep 2021 21:58:29 -0700 Subject: [PATCH 14/17] Improve feature request template --- .github/ISSUE_TEMPLATE/feature_request.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index f9e66c0..f3b84ea 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -8,7 +8,7 @@ body: required: true attributes: label: Is the feature request related to a problem. Please describe it. - description: e.g. I have an issue when... + placeholder: I have an issue when... - type: textarea validations: @@ -16,8 +16,10 @@ body: attributes: label: Describe the solution you would like. description: A clear and concise description of what you want to happen. Add any considered drawbacks. + placeholder: I would like streamrip to... - type: textarea attributes: label: Describe alternatives you've considered. description: A clear and concise description of any alternative solutions or features you've considered. + placeholder: '"I have already tried X" or "I do Y as a temporary solution"' From b087d43b92fe62454316f8cd2b8ef8d0c4932ee4 Mon Sep 17 00:00:00 2001 From: Nathan Thomas <nathanthomas707@gmail.com> Date: Thu, 16 Sep 2021 18:25:49 -0700 Subject: [PATCH 15/17] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index abb1860..95395e0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # streamrip -[![Downloads](https://img.shields.io/pypi/dm/streamrip)](https://pypistats.org/packages/streamrip) +[![Downloads](https://pepy.tech/badge/streamrip)](https://pepy.tech/project/streamrip) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black) A scriptable stream downloader for Qobuz, Tidal, Deezer and SoundCloud. From a43c24391825108893da12ee3984f91ea3d7e462 Mon Sep 17 00:00:00 2001 From: Nathan Thomas <nathanthomas707@gmail.com> Date: Mon, 27 Sep 2021 09:17:58 -0700 Subject: [PATCH 16/17] Delete bug_report.yaml --- .github/ISSUE_TEMPLATE/bug_report.yaml | 106 ------------------------- 1 file changed, 106 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml deleted file mode 100644 index 2bd07ac..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ /dev/null @@ -1,106 +0,0 @@ -name: Bug report -description: Create a report to help us improve streamrip -labels: bug -body: - # types: dropdown, textarea, input - # - type: dropdown - # validations: - # required: true - # attributes: - # label: Are you using "tree-sitter" branch? - # options: - # - 'Yes' - # - 'No' - - - type: textarea - validations: - required: true - attributes: - label: Describe the bug - description: A clear and concise description of the bug. - - - type: textarea - validations: - required: true - attributes: - label: Command Used - description: | - The command that you typed that caused the error - placeholder: | - For example: - `rip url https://example.com` - - - type: markdown - attributes: - value: "```\n" - - - type: textarea - validations: - required: true - attributes: - label: Debug Traceback - description: | - Run your command, with `-vvv` appended to it, and paste the output here. - For example, if the problematic command was `rip url https://example.com`, then - you would run `rip url https://example.com -vvv` to get the debug logs. - Make sure to check the logs for any personal information such as emails and remove them. - - - type: markdown - attributes: - value: "```" - - - type: markdown - attributes: - value: "```toml\n" - - - type: textarea - validations: - required: true - attributes: - label: Config File - description: | - Find the config file using `rip config --open` and paste the contents here. - Make sure you REMOVE YOUR CREDENTIALS! - - - type: markdown - attributes: - value: "```" - - - type: input - validations: - required: true - attributes: - label: Operating System - placeholder: e.g. Windows, Linux, macOS... - - - type: markdown - attributes: - value: "```\n" - - - type: input - validations: - required: true - attributes: - label: streamrip version - description: Run `rip --version` to check. - placeholder: e.g. 1.5 - - - type: markdown - attributes: - value: "```" - - - type: textarea - attributes: - label: Screenshots and recordings - description: | - If applicable, add screenshots to help explain your problem. - You can also record an asciinema session: https://asciinema.org/ - - - type: textarea - attributes: - label: Additional context - description: Add any other context about the problem here. - - - type: markdown - attributes: - value: "Thanks for completing our form!" From c9e75d01c254645efca8e77f9f19a649d83b4866 Mon Sep 17 00:00:00 2001 From: Nathan Thomas <nathanthomas707@gmail.com> Date: Mon, 27 Sep 2021 09:18:07 -0700 Subject: [PATCH 17/17] Delete config.yaml --- .github/ISSUE_TEMPLATE/config.yaml | 1 - 1 file changed, 1 deletion(-) delete mode 100644 .github/ISSUE_TEMPLATE/config.yaml diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml deleted file mode 100644 index 3ba13e0..0000000 --- a/.github/ISSUE_TEMPLATE/config.yaml +++ /dev/null @@ -1 +0,0 @@ -blank_issues_enabled: false