From 33c69087ce8cbb5dff50e31b46308f21774158bc Mon Sep 17 00:00:00 2001 From: Alex Shnitman Date: Mon, 8 Sep 2025 22:20:08 +0300 Subject: [PATCH] issue and discussion templates --- .github/DISCUSSION_TEMPLATE/config.yml | 1 + .../configuration-help.yml | 65 ++++++++++++++ .github/DISCUSSION_TEMPLATE/general.yml | 45 ++++++++++ .github/DISCUSSION_TEMPLATE/q-and-a.yml | 60 +++++++++++++ .github/ISSUE_TEMPLATE/bug_report.yml | 87 +++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/feature_request.yml | 62 +++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 62 +++++++++++++ 8 files changed, 390 insertions(+) create mode 100644 .github/DISCUSSION_TEMPLATE/config.yml create mode 100644 .github/DISCUSSION_TEMPLATE/configuration-help.yml create mode 100644 .github/DISCUSSION_TEMPLATE/general.yml create mode 100644 .github/DISCUSSION_TEMPLATE/q-and-a.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/DISCUSSION_TEMPLATE/config.yml b/.github/DISCUSSION_TEMPLATE/config.yml new file mode 100644 index 0000000..790117c --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_discussions_enabled: false diff --git a/.github/DISCUSSION_TEMPLATE/configuration-help.yml b/.github/DISCUSSION_TEMPLATE/configuration-help.yml new file mode 100644 index 0000000..d34155f --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/configuration-help.yml @@ -0,0 +1,65 @@ +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#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#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 new file mode 100644 index 0000000..debc250 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/general.yml @@ -0,0 +1,45 @@ +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 + + - type: textarea + id: discussion-topic + attributes: + label: Discussion Topic + description: What would you like to discuss about MeTube? + 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/q-and-a.yml b/.github/DISCUSSION_TEMPLATE/q-and-a.yml new file mode 100644 index 0000000..ccae5ac --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/q-and-a.yml @@ -0,0 +1,60 @@ +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 new file mode 100644 index 0000000..7492333 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,87 @@ +name: 🐛 Bug Report +description: Report a bug or unexpected behavior in MeTube +title: "[Bug]: " +labels: ["bug"] +assignees: [] + +body: + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + description: Please confirm you have completed these steps before submitting your bug report + 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) + 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 + + - type: textarea + id: bug-description + attributes: + label: Bug Description + description: Describe the bug, what you expected to happen, and what actually happened + placeholder: | + What happened? + What did you expect to happen? + Steps to reproduce: + 1. Go to '...' + 2. Click on '....' + 3. See error + validations: + required: true + + - type: textarea + id: ytdl-test-results + attributes: + label: yt-dlp Direct Test Results + description: Results of testing the same URL/configuration directly with yt-dlp (required) + placeholder: | + Command used: yt-dlp [your-command-here] + Result: [success/error and output] + validations: + required: true + + - type: textarea + id: environment-and-config + attributes: + label: Environment & Configuration + description: Your setup details and MeTube configuration + placeholder: | + Environment: + - 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 + ``` + validations: + required: true + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Any other information that might be helpful + placeholder: Screenshots, error messages, or other relevant information + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..aeb0284 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +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 + 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 new file mode 100644 index 0000000..abc1205 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,62 @@ +name: ✨ Feature Request +description: Suggest a new feature or enhancement for MeTube +title: "[Feature]: " +labels: ["enhancement"] +assignees: [] + +body: + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + description: Please confirm you have completed these steps before submitting your feature request + options: + - label: I have searched existing issues and discussions to ensure this feature hasn't been requested before + required: true + - label: I have read the [feature request guidelines](https://github.com/alexta69/metube#submitting-feature-requests) in the README + 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 + attributes: + label: Feature Description + description: Describe the feature you'd like to see and what problem it solves + placeholder: | + What feature would you like to see? + What problem does it solve? + How would it work? + validations: + required: true + + - type: dropdown + id: implementation-plan + attributes: + label: Implementation Plan + description: Do you plan to implement this feature yourself? (Optional - others may pick it up) + options: + - "Yes, I will implement this feature and submit a PR" + - "No, I'm requesting this feature but cannot implement it" + - "Maybe, I'd like to discuss the implementation approach first" + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Any other information that might be helpful (mockups, technical details, alternatives, etc.) + placeholder: Screenshots, mockups, technical details, or other relevant information + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..bcc822f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,62 @@ +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