diff --git a/.github/DISCUSSION_TEMPLATE/config.yml b/.github/DISCUSSION_TEMPLATE/config.yml deleted file mode 100644 index 790117c..0000000 --- a/.github/DISCUSSION_TEMPLATE/config.yml +++ /dev/null @@ -1 +0,0 @@ -blank_discussions_enabled: false diff --git a/.github/DISCUSSION_TEMPLATE/configuration-help.yml b/.github/DISCUSSION_TEMPLATE/configuration-help.yml deleted file mode 100644 index 6f3965b..0000000 --- a/.github/DISCUSSION_TEMPLATE/configuration-help.yml +++ /dev/null @@ -1,65 +0,0 @@ -name: ⚙️ Configuration Help -description: Get help with MeTube configuration and setup -title: "[Config]: " -labels: ["configuration", "help"] -assignees: [] - -body: - - type: checkboxes - id: prerequisites - attributes: - label: Prerequisites - description: Please confirm you have completed these steps before asking for configuration help - options: - - label: I have searched existing discussions and issues for similar configuration problems - required: true - - label: I have read the [configuration section](https://github.com/alexta69/metube#%EF%B8%8F-configuration-via-environment-variables) in the README - required: true - - label: I have checked the [Wiki](https://github.com/alexta69/metube/wiki) for configuration examples - required: true - - - type: markdown - attributes: - value: | - ## Configuration Resources - - Before asking for help, please check these resources: - - **[Configuration Guide](https://github.com/alexta69/metube#%EF%B8%8F-configuration-via-environment-variables)** - All available environment variables - - **[YTDL_OPTIONS Cookbook](https://github.com/alexta69/metube/wiki/YTDL_OPTIONS-Cookbook)** - Common yt-dlp configurations - - **[OUTPUT_TEMPLATE Cookbook](https://github.com/alexta69/metube/wiki/OUTPUT_TEMPLATE-Cookbook)** - Filename template examples - - - type: textarea - id: configuration-goal - attributes: - label: What are you trying to configure? - description: Describe what you want to achieve with your MeTube configuration - placeholder: | - What specific behavior are you trying to achieve? - What's not working as expected? - What have you tried so far? - validations: - required: true - - - type: textarea - id: additional-context - attributes: - label: Additional Context - description: Your configuration, environment details, errors, and any other helpful information - placeholder: | - Current Configuration: - ```yaml - # Your docker-compose.yml or environment variables - ``` - - Environment Details: - - MeTube version: [e.g., latest, specific version] - - Docker image: [e.g., ghcr.io/alexta69/metube:latest] - - Operating System: [e.g., Ubuntu 20.04, Windows 10, macOS 12] - - Error Messages or Issues: - [Paste any error messages, logs, or unexpected behavior here] - - Other relevant information: - [Screenshots, examples, etc.] - validations: - required: true diff --git a/.github/DISCUSSION_TEMPLATE/general.yml b/.github/DISCUSSION_TEMPLATE/general.yml index debc250..37790eb 100644 --- a/.github/DISCUSSION_TEMPLATE/general.yml +++ b/.github/DISCUSSION_TEMPLATE/general.yml @@ -1,30 +1,13 @@ -name: 💬 General Discussion -description: Start a general discussion about MeTube -title: "[Discussion]: " -labels: ["discussion"] -assignees: [] - body: - - type: checkboxes - id: prerequisites - attributes: - label: Prerequisites - description: Please confirm you have completed these steps before starting a discussion - options: - - label: I have searched existing discussions to ensure this topic hasn't been discussed before - required: true - - label: I have read the [README](https://github.com/alexta69/metube#readme) and relevant sections - required: true - - type: markdown attributes: value: | ## Discussion Guidelines - - This is for general discussions about MeTube. For specific issues, please use: - - **Bug reports** → Use the Bug Report issue template - - **Feature requests** → Use the Feature Request issue template - - **Questions** → Use the Question issue template + + This is for general discussions about MeTube. For specific topics, better homes exist: + - **Bug reports** → [open an issue](https://github.com/alexta69/metube/issues/new?template=bug_report.yml) + - **Feature requests** → [open an issue](https://github.com/alexta69/metube/issues/new?template=feature_request.yml) or post in [Ideas](https://github.com/alexta69/metube/discussions/categories/ideas) + - **Questions** → post in [Q&A](https://github.com/alexta69/metube/discussions/categories/q-a) - type: textarea id: discussion-topic @@ -34,12 +17,3 @@ body: placeholder: Please provide a clear topic for discussion validations: required: true - - - type: textarea - id: additional-context - attributes: - label: Additional Context - description: Any other information that might be helpful for the discussion - placeholder: Links, examples, or other relevant information - validations: - required: false diff --git a/.github/DISCUSSION_TEMPLATE/ideas.yml b/.github/DISCUSSION_TEMPLATE/ideas.yml new file mode 100644 index 0000000..05e42ed --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/ideas.yml @@ -0,0 +1,31 @@ +body: + - type: markdown + attributes: + value: | + ## Read this first — MeTube's scope + + MeTube's scope is deliberately narrow: **it downloads well and stops once the file is written.** + Ideas that improve the download itself are welcome — usually as community PRs, since the + maintainer is unlikely to implement requests ([details](https://github.com/alexta69/metube#-submitting-feature-requests)). + Post-download file management is out of scope regardless of implementation quality. + + **Already decided — please don't re-request:** + - 🔒 Built-in authentication / password → use a reverse proxy ([#931](https://github.com/alexta69/metube/issues/931), [wiki](https://github.com/alexta69/metube/wiki/Reverse-proxy-configurations)) + - 🔔 Notifications on download completion → available today via the `Exec` postprocessor ([recipe](https://github.com/alexta69/metube/wiki/YTDL_OPTIONS-Cookbook)) + - ✏️ Renaming, converting, tagging, or organizing files after download → out of scope ([#495](https://github.com/alexta69/metube/issues/495), [#1027](https://github.com/alexta69/metube/issues/1027)) + - 🎚️ Pre-download format/quality/audio-track picker → tracked in [#1032](https://github.com/alexta69/metube/issues/1032) + - 📋 Pre-download playlist item browser → tracked in [#1030](https://github.com/alexta69/metube/issues/1030) + - 🎛️ Config switches to disable individual features → declined ([#976](https://github.com/alexta69/metube/issues/976)) + - ⏰ Download scheduler → declined; add items with auto-start off and start them when you like ([#838](https://github.com/alexta69/metube/issues/838)) + + - type: textarea + id: idea + attributes: + label: Your Idea + description: Describe the idea and what problem it solves + placeholder: | + What would you like to see? + What problem does it solve? + Would you be willing to implement it as a PR? + validations: + required: true diff --git a/.github/DISCUSSION_TEMPLATE/q-a.yml b/.github/DISCUSSION_TEMPLATE/q-a.yml new file mode 100644 index 0000000..7abdb42 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/q-a.yml @@ -0,0 +1,23 @@ +body: + - type: markdown + attributes: + value: | + ## Quick Resources + + Your question may already be answered here: + - **[README](https://github.com/alexta69/metube#readme)** — complete setup and configuration guide + - **[Troubleshooting FAQ](https://github.com/alexta69/metube/wiki/Troubleshooting-FAQ)** — common problems and their fixes + - **[YTDL_OPTIONS Cookbook](https://github.com/alexta69/metube/wiki/YTDL_OPTIONS-Cookbook)** — common yt-dlp configurations (notifications, metadata, audio extraction, ...) + - **[OUTPUT_TEMPLATE Cookbook](https://github.com/alexta69/metube/wiki/OUTPUT_TEMPLATE-Cookbook)** — filename template examples + + - type: textarea + id: question + attributes: + label: Your Question + description: What would you like to know about MeTube? + placeholder: | + What are you trying to achieve? + What's your current setup (docker-compose / environment variables)? + What have you tried so far, and what happened (errors, logs)? + validations: + required: true diff --git a/.github/DISCUSSION_TEMPLATE/q-and-a.yml b/.github/DISCUSSION_TEMPLATE/q-and-a.yml deleted file mode 100644 index ccae5ac..0000000 --- a/.github/DISCUSSION_TEMPLATE/q-and-a.yml +++ /dev/null @@ -1,60 +0,0 @@ -name: ❓ Q&A -description: Ask a question and get answers from the community -title: "[Q&A]: " -labels: ["q-and-a"] -assignees: [] - -body: - - type: checkboxes - id: prerequisites - attributes: - label: Prerequisites - description: Please confirm you have completed these steps before asking your question - options: - - label: I have searched existing discussions and issues to see if my question has been answered before - required: true - - label: I have read the [README](https://github.com/alexta69/metube#readme) and relevant sections - required: true - - label: I have checked the [Wiki](https://github.com/alexta69/metube/wiki) for configuration examples - required: true - - - type: markdown - attributes: - value: | - ## Quick Resources - - Before asking your question, please check these resources: - - **[README](https://github.com/alexta69/metube#readme)** - Complete setup and configuration guide - - **[YTDL_OPTIONS Cookbook](https://github.com/alexta69/metube/wiki/YTDL_OPTIONS-Cookbook)** - Common yt-dlp configurations - - **[OUTPUT_TEMPLATE Cookbook](https://github.com/alexta69/metube/wiki/OUTPUT_TEMPLATE-Cookbook)** - Filename template examples - - - type: textarea - id: question - attributes: - label: Your Question - description: What would you like to know about MeTube? - placeholder: | - What are you trying to achieve? - What's your current setup? - What have you tried so far? - validations: - required: true - - - type: textarea - id: additional-context - attributes: - label: Additional Context - description: Any other information that might be helpful (configuration, errors, screenshots, etc.) - placeholder: | - Configuration: - ```yaml - # Your docker-compose.yml or environment variables - ``` - - Error messages or logs: - [Paste any error messages or logs here] - - Other relevant information: - [Screenshots, examples, etc.] - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ac6da39..30c1187 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -9,24 +9,20 @@ body: id: prerequisites attributes: label: Prerequisites - description: Please confirm you have completed these steps before submitting your bug report + description: Please confirm before submitting options: - label: I have searched existing issues and discussions to ensure this bug hasn't been reported before required: true - - label: I have read the [troubleshooting section](https://github.com/alexta69/metube#-troubleshooting-and-submitting-issues) in the README - required: true - - label: I have tested this issue with yt-dlp directly (not just through MeTube UI) as described in the README - required: true - - label: I have checked that this is not a yt-dlp issue (if it is, please report it to [yt-dlp repository](https://github.com/yt-dlp/yt-dlp/issues) instead) + - label: If the download itself fails, I have tested the same URL and options with yt-dlp directly (see the note below) — or this bug is not download-related required: true - type: markdown attributes: value: | ## Important Notes - - **MeTube is only a UI for yt-dlp** - issues with authentication, postprocessing, permissions, or other yt-dlp functionality should be reported to the [yt-dlp repository](https://github.com/yt-dlp/yt-dlp/issues) - - Before reporting, please test with yt-dlp directly using: `docker exec -ti metube sh` then `cd /downloads` and run yt-dlp commands - - If yt-dlp works directly but MeTube doesn't, then it's a MeTube issue + - **MeTube is only a UI for [yt-dlp](https://github.com/yt-dlp/yt-dlp)** — issues with authentication, postprocessing, site support, or other download functionality should be reported to the [yt-dlp repository](https://github.com/yt-dlp/yt-dlp/issues) + - To test with yt-dlp directly: `docker exec -ti metube sh`, then `cd /downloads` and run `yt-dlp` with your URL and options + - If yt-dlp works directly but MeTube doesn't, then it's a MeTube issue — report it here - type: textarea id: bug-description @@ -47,10 +43,13 @@ body: id: ytdl-test-results attributes: label: yt-dlp Direct Test Results - description: Results of testing the same URL/configuration directly with yt-dlp (required) + description: >- + If the download itself fails: paste the exact yt-dlp command you ran AND its output — + download-failure reports without this will be closed as needs-info. + If this is a UI or app bug that doesn't involve a failing download, just write "UI bug". placeholder: | Command used: yt-dlp [your-command-here] - Result: [success/error and output] + Result: [paste the output here] validations: required: true @@ -64,12 +63,12 @@ body: - MeTube version: [e.g., latest, specific version] - Docker image: [e.g., ghcr.io/alexta69/metube:latest] - Operating System: [e.g., Ubuntu 20.04, Windows 10, macOS 12] - + Configuration: ```yaml # Your docker-compose.yml or environment variables ``` - + Logs: ```bash docker logs metube diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index aeb0284..56bad3e 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,11 @@ blank_issues_enabled: false contact_links: - - name: MeTube Community Discussions - url: https://github.com/alexta69/metube/discussions - about: Ask questions and discuss MeTube with the community - - name: yt-dlp Issues + - name: ❓ Questions & Support + url: https://github.com/alexta69/metube/discussions/categories/q-a + about: Ask usage and configuration questions in Discussions Q&A — issues are for bugs and feature requests + - name: 📖 Troubleshooting FAQ + url: https://github.com/alexta69/metube/wiki/Troubleshooting-FAQ + about: Common problems and their fixes + - name: ⬇️ yt-dlp Issues url: https://github.com/yt-dlp/yt-dlp/issues about: Report issues related to video downloading, authentication, or site support diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index e8a2255..a48de8d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -5,28 +5,35 @@ labels: ["enhancement"] assignees: [] body: + - type: markdown + attributes: + value: | + ## Read this first — MeTube's scope + + MeTube's scope is deliberately narrow: **it downloads well and stops once the file is written.** + Features that improve the download itself are welcome — usually as community PRs, since the + maintainer is unlikely to implement requests ([details](https://github.com/alexta69/metube#-submitting-feature-requests)). + Post-download file management is out of scope regardless of implementation quality. + + **Already decided — please don't re-request:** + - 🔒 Built-in authentication / password → use a reverse proxy ([#931](https://github.com/alexta69/metube/issues/931), [wiki](https://github.com/alexta69/metube/wiki/Reverse-proxy-configurations)) + - 🔔 Notifications on download completion → available today via the `Exec` postprocessor ([recipe](https://github.com/alexta69/metube/wiki/YTDL_OPTIONS-Cookbook)) + - ✏️ Renaming, converting, tagging, or organizing files after download → out of scope ([#495](https://github.com/alexta69/metube/issues/495), [#1027](https://github.com/alexta69/metube/issues/1027)) + - 🎚️ Pre-download format/quality/audio-track picker → tracked in [#1032](https://github.com/alexta69/metube/issues/1032) + - 📋 Pre-download playlist item browser → tracked in [#1030](https://github.com/alexta69/metube/issues/1030) + - 🎛️ Config switches to disable individual features → declined ([#976](https://github.com/alexta69/metube/issues/976)) + - ⏰ Download scheduler → declined; add items with auto-start off and start them when you like ([#838](https://github.com/alexta69/metube/issues/838)) + - type: checkboxes id: prerequisites attributes: label: Prerequisites - description: Please confirm you have completed these steps before submitting your feature request + description: Please confirm before submitting options: - - label: I have searched existing issues and discussions to ensure this feature hasn't been requested before + - label: I have searched existing issues and checked the "Already decided" list above required: true - - label: I have read the [feature request guidelines](https://github.com/alexta69/metube#-submitting-feature-requests) in the README + - label: I have considered if this feature belongs in yt-dlp instead (downloading, processing, site support) — if so, please request it in the [yt-dlp repository](https://github.com/yt-dlp/yt-dlp/issues) required: true - - label: I understand that MeTube development relies on community contributions and the maintainer is not likely to implement this feature - required: true - - label: I have considered if this feature should be implemented in yt-dlp instead of MeTube (if so, please report to [yt-dlp repository](https://github.com/yt-dlp/yt-dlp/issues)) - required: true - - - type: markdown - attributes: - value: | - ## Important Notes - - **MeTube development relies on code contributions by the community** - the project is feature-complete for the maintainer's use cases - - **Consider if this belongs in yt-dlp** - if it's related to video downloading, processing, or site support, it might belong in the [yt-dlp repository](https://github.com/yt-dlp/yt-dlp/issues) instead - - **Some features may not be accepted** - in an effort to reduce bloat, some PRs may not be accepted - type: textarea id: feature-description diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml deleted file mode 100644 index 3ca15dd..0000000 --- a/.github/ISSUE_TEMPLATE/question.yml +++ /dev/null @@ -1,62 +0,0 @@ -name: ❓ Question -description: Ask a question about MeTube usage, configuration, or general help -title: "[Question]: " -labels: ["question"] -assignees: [] - -body: - - type: checkboxes - id: prerequisites - attributes: - label: Prerequisites - description: Please confirm you have completed these steps before asking your question - options: - - label: I have searched existing issues and discussions to see if my question has been answered before - required: true - - label: I have read the [README](https://github.com/alexta69/metube#readme) and relevant sections - required: true - - label: I have checked the [Wiki](https://github.com/alexta69/metube/wiki) for configuration examples - required: true - - label: I have read the [troubleshooting section](https://github.com/alexta69/metube#-troubleshooting-and-submitting-issues) if this is a technical issue - required: true - - - type: markdown - attributes: - value: | - ## Quick Resources - - Before asking your question, please check these resources: - - **[README](https://github.com/alexta69/metube#readme)** - Complete setup and configuration guide - - **[YTDL_OPTIONS Cookbook](https://github.com/alexta69/metube/wiki/YTDL_OPTIONS-Cookbook)** - Common yt-dlp configurations - - **[OUTPUT_TEMPLATE Cookbook](https://github.com/alexta69/metube/wiki/OUTPUT_TEMPLATE-Cookbook)** - Filename template examples - - - type: textarea - id: question - attributes: - label: Your Question - description: What would you like to know about MeTube? - placeholder: | - What are you trying to achieve? - What's your current setup? - What have you tried so far? - validations: - required: true - - - type: textarea - id: additional-context - attributes: - label: Additional Context - description: Any other information that might be helpful (configuration, errors, screenshots, etc.) - placeholder: | - Configuration: - ```yaml - # Your docker-compose.yml or environment variables - ``` - - Error messages or logs: - [Paste any error messages or logs here] - - Other relevant information: - [Screenshots, examples, etc.] - validations: - required: false