Skip to content

Commit 33c6908

Browse files
alexta69alexta69
committed
issue and discussion templates
1 parent 6d88900 commit 33c6908

File tree

8 files changed

+390
-0
lines changed

8 files changed

+390
-0
lines changed

‎.github/DISCUSSION_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_discussions_enabled: false

‎.github/DISCUSSION_TEMPLATE/configuration-help.yml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: ⚙️ Configuration Help
2+
description: Get help with MeTube configuration and setup
3+
title: "[Config]: "
4+
labels: ["configuration", "help"]
5+
assignees: []
6+
7+
body:
8+
- type: checkboxes
9+
id: prerequisites
10+
attributes:
11+
label: Prerequisites
12+
description: Please confirm you have completed these steps before asking for configuration help
13+
options:
14+
- label: I have searched existing discussions and issues for similar configuration problems
15+
required: true
16+
- label: I have read the [configuration section](https://github.com/alexta69/metube#configuration-via-environment-variables) in the README
17+
required: true
18+
- label: I have checked the [Wiki](https://github.com/alexta69/metube/wiki) for configuration examples
19+
required: true
20+
21+
- type: markdown
22+
attributes:
23+
value: |
24+
## Configuration Resources
25+
26+
Before asking for help, please check these resources:
27+
- **[Configuration Guide](https://github.com/alexta69/metube#configuration-via-environment-variables)** - All available environment variables
28+
- **[YTDL_OPTIONS Cookbook](https://github.com/alexta69/metube/wiki/YTDL_OPTIONS-Cookbook)** - Common yt-dlp configurations
29+
- **[OUTPUT_TEMPLATE Cookbook](https://github.com/alexta69/metube/wiki/OUTPUT_TEMPLATE-Cookbook)** - Filename template examples
30+
31+
- type: textarea
32+
id: configuration-goal
33+
attributes:
34+
label: What are you trying to configure?
35+
description: Describe what you want to achieve with your MeTube configuration
36+
placeholder: |
37+
What specific behavior are you trying to achieve?
38+
What's not working as expected?
39+
What have you tried so far?
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: additional-context
45+
attributes:
46+
label: Additional Context
47+
description: Your configuration, environment details, errors, and any other helpful information
48+
placeholder: |
49+
Current Configuration:
50+
```yaml
51+
# Your docker-compose.yml or environment variables
52+
```
53+
54+
Environment Details:
55+
- MeTube version: [e.g., latest, specific version]
56+
- Docker image: [e.g., ghcr.io/alexta69/metube:latest]
57+
- Operating System: [e.g., Ubuntu 20.04, Windows 10, macOS 12]
58+
59+
Error Messages or Issues:
60+
[Paste any error messages, logs, or unexpected behavior here]
61+
62+
Other relevant information:
63+
[Screenshots, examples, etc.]
64+
validations:
65+
required: true

‎.github/DISCUSSION_TEMPLATE/general.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: 💬 General Discussion
2+
description: Start a general discussion about MeTube
3+
title: "[Discussion]: "
4+
labels: ["discussion"]
5+
assignees: []
6+
7+
body:
8+
- type: checkboxes
9+
id: prerequisites
10+
attributes:
11+
label: Prerequisites
12+
description: Please confirm you have completed these steps before starting a discussion
13+
options:
14+
- label: I have searched existing discussions to ensure this topic hasn't been discussed before
15+
required: true
16+
- label: I have read the [README](https://github.com/alexta69/metube#readme) and relevant sections
17+
required: true
18+
19+
- type: markdown
20+
attributes:
21+
value: |
22+
## Discussion Guidelines
23+
24+
This is for general discussions about MeTube. For specific issues, please use:
25+
- **Bug reports** → Use the Bug Report issue template
26+
- **Feature requests** → Use the Feature Request issue template
27+
- **Questions** → Use the Question issue template
28+
29+
- type: textarea
30+
id: discussion-topic
31+
attributes:
32+
label: Discussion Topic
33+
description: What would you like to discuss about MeTube?
34+
placeholder: Please provide a clear topic for discussion
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: additional-context
40+
attributes:
41+
label: Additional Context
42+
description: Any other information that might be helpful for the discussion
43+
placeholder: Links, examples, or other relevant information
44+
validations:
45+
required: false

‎.github/DISCUSSION_TEMPLATE/q-and-a.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: ❓ Q&A
2+
description: Ask a question and get answers from the community
3+
title: "[Q&A]: "
4+
labels: ["q-and-a"]
5+
assignees: []
6+
7+
body:
8+
- type: checkboxes
9+
id: prerequisites
10+
attributes:
11+
label: Prerequisites
12+
description: Please confirm you have completed these steps before asking your question
13+
options:
14+
- label: I have searched existing discussions and issues to see if my question has been answered before
15+
required: true
16+
- label: I have read the [README](https://github.com/alexta69/metube#readme) and relevant sections
17+
required: true
18+
- label: I have checked the [Wiki](https://github.com/alexta69/metube/wiki) for configuration examples
19+
required: true
20+
21+
- type: markdown
22+
attributes:
23+
value: |
24+
## Quick Resources
25+
26+
Before asking your question, please check these resources:
27+
- **[README](https://github.com/alexta69/metube#readme)** - Complete setup and configuration guide
28+
- **[YTDL_OPTIONS Cookbook](https://github.com/alexta69/metube/wiki/YTDL_OPTIONS-Cookbook)** - Common yt-dlp configurations
29+
- **[OUTPUT_TEMPLATE Cookbook](https://github.com/alexta69/metube/wiki/OUTPUT_TEMPLATE-Cookbook)** - Filename template examples
30+
31+
- type: textarea
32+
id: question
33+
attributes:
34+
label: Your Question
35+
description: What would you like to know about MeTube?
36+
placeholder: |
37+
What are you trying to achieve?
38+
What's your current setup?
39+
What have you tried so far?
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: additional-context
45+
attributes:
46+
label: Additional Context
47+
description: Any other information that might be helpful (configuration, errors, screenshots, etc.)
48+
placeholder: |
49+
Configuration:
50+
```yaml
51+
# Your docker-compose.yml or environment variables
52+
```
53+
54+
Error messages or logs:
55+
[Paste any error messages or logs here]
56+
57+
Other relevant information:
58+
[Screenshots, examples, etc.]
59+
validations:
60+
required: false

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or unexpected behavior in MeTube
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
assignees: []
6+
7+
body:
8+
- type: checkboxes
9+
id: prerequisites
10+
attributes:
11+
label: Prerequisites
12+
description: Please confirm you have completed these steps before submitting your bug report
13+
options:
14+
- label: I have searched existing issues and discussions to ensure this bug hasn't been reported before
15+
required: true
16+
- label: I have read the [troubleshooting section](https://github.com/alexta69/metube#troubleshooting-and-submitting-issues) in the README
17+
required: true
18+
- label: I have tested this issue with yt-dlp directly (not just through MeTube UI) as described in the README
19+
required: true
20+
- 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)
21+
required: true
22+
23+
- type: markdown
24+
attributes:
25+
value: |
26+
## Important Notes
27+
- **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)
28+
- Before reporting, please test with yt-dlp directly using: `docker exec -ti metube sh` then `cd /downloads` and run yt-dlp commands
29+
- If yt-dlp works directly but MeTube doesn't, then it's a MeTube issue
30+
31+
- type: textarea
32+
id: bug-description
33+
attributes:
34+
label: Bug Description
35+
description: Describe the bug, what you expected to happen, and what actually happened
36+
placeholder: |
37+
What happened?
38+
What did you expect to happen?
39+
Steps to reproduce:
40+
1. Go to '...'
41+
2. Click on '....'
42+
3. See error
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: ytdl-test-results
48+
attributes:
49+
label: yt-dlp Direct Test Results
50+
description: Results of testing the same URL/configuration directly with yt-dlp (required)
51+
placeholder: |
52+
Command used: yt-dlp [your-command-here]
53+
Result: [success/error and output]
54+
validations:
55+
required: true
56+
57+
- type: textarea
58+
id: environment-and-config
59+
attributes:
60+
label: Environment & Configuration
61+
description: Your setup details and MeTube configuration
62+
placeholder: |
63+
Environment:
64+
- MeTube version: [e.g., latest, specific version]
65+
- Docker image: [e.g., ghcr.io/alexta69/metube:latest]
66+
- Operating System: [e.g., Ubuntu 20.04, Windows 10, macOS 12]
67+
68+
Configuration:
69+
```yaml
70+
# Your docker-compose.yml or environment variables
71+
```
72+
73+
Logs:
74+
```bash
75+
docker logs metube
76+
```
77+
validations:
78+
required: true
79+
80+
- type: textarea
81+
id: additional-context
82+
attributes:
83+
label: Additional Context
84+
description: Any other information that might be helpful
85+
placeholder: Screenshots, error messages, or other relevant information
86+
validations:
87+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: MeTube Community Discussions
4+
url: https://github.com/alexta69/metube/discussions
5+
about: Ask questions and discuss MeTube with the community
6+
- name: yt-dlp Issues
7+
url: https://github.com/yt-dlp/yt-dlp/issues
8+
about: Report issues related to video downloading, authentication, or site support

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: ✨ Feature Request
2+
description: Suggest a new feature or enhancement for MeTube
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
assignees: []
6+
7+
body:
8+
- type: checkboxes
9+
id: prerequisites
10+
attributes:
11+
label: Prerequisites
12+
description: Please confirm you have completed these steps before submitting your feature request
13+
options:
14+
- label: I have searched existing issues and discussions to ensure this feature hasn't been requested before
15+
required: true
16+
- label: I have read the [feature request guidelines](https://github.com/alexta69/metube#submitting-feature-requests) in the README
17+
required: true
18+
- label: I understand that MeTube development relies on community contributions and the maintainer is not likely to implement this feature
19+
required: true
20+
- 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))
21+
required: true
22+
23+
- type: markdown
24+
attributes:
25+
value: |
26+
## Important Notes
27+
- **MeTube development relies on code contributions by the community** - the project is feature-complete for the maintainer's use cases
28+
- **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
29+
- **Some features may not be accepted** - in an effort to reduce bloat, some PRs may not be accepted
30+
31+
- type: textarea
32+
id: feature-description
33+
attributes:
34+
label: Feature Description
35+
description: Describe the feature you'd like to see and what problem it solves
36+
placeholder: |
37+
What feature would you like to see?
38+
What problem does it solve?
39+
How would it work?
40+
validations:
41+
required: true
42+
43+
- type: dropdown
44+
id: implementation-plan
45+
attributes:
46+
label: Implementation Plan
47+
description: Do you plan to implement this feature yourself? (Optional - others may pick it up)
48+
options:
49+
- "Yes, I will implement this feature and submit a PR"
50+
- "No, I'm requesting this feature but cannot implement it"
51+
- "Maybe, I'd like to discuss the implementation approach first"
52+
validations:
53+
required: false
54+
55+
- type: textarea
56+
id: additional-context
57+
attributes:
58+
label: Additional Context
59+
description: Any other information that might be helpful (mockups, technical details, alternatives, etc.)
60+
placeholder: Screenshots, mockups, technical details, or other relevant information
61+
validations:
62+
required: false

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: ❓ Question
2+
description: Ask a question about MeTube usage, configuration, or general help
3+
title: "[Question]: "
4+
labels: ["question"]
5+
assignees: []
6+
7+
body:
8+
- type: checkboxes
9+
id: prerequisites
10+
attributes:
11+
label: Prerequisites
12+
description: Please confirm you have completed these steps before asking your question
13+
options:
14+
- label: I have searched existing issues and discussions to see if my question has been answered before
15+
required: true
16+
- label: I have read the [README](https://github.com/alexta69/metube#readme) and relevant sections
17+
required: true
18+
- label: I have checked the [Wiki](https://github.com/alexta69/metube/wiki) for configuration examples
19+
required: true
20+
- label: I have read the [troubleshooting section](https://github.com/alexta69/metube#troubleshooting-and-submitting-issues) if this is a technical issue
21+
required: true
22+
23+
- type: markdown
24+
attributes:
25+
value: |
26+
## Quick Resources
27+
28+
Before asking your question, please check these resources:
29+
- **[README](https://github.com/alexta69/metube#readme)** - Complete setup and configuration guide
30+
- **[YTDL_OPTIONS Cookbook](https://github.com/alexta69/metube/wiki/YTDL_OPTIONS-Cookbook)** - Common yt-dlp configurations
31+
- **[OUTPUT_TEMPLATE Cookbook](https://github.com/alexta69/metube/wiki/OUTPUT_TEMPLATE-Cookbook)** - Filename template examples
32+
33+
- type: textarea
34+
id: question
35+
attributes:
36+
label: Your Question
37+
description: What would you like to know about MeTube?
38+
placeholder: |
39+
What are you trying to achieve?
40+
What's your current setup?
41+
What have you tried so far?
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: additional-context
47+
attributes:
48+
label: Additional Context
49+
description: Any other information that might be helpful (configuration, errors, screenshots, etc.)
50+
placeholder: |
51+
Configuration:
52+
```yaml
53+
# Your docker-compose.yml or environment variables
54+
```
55+
56+
Error messages or logs:
57+
[Paste any error messages or logs here]
58+
59+
Other relevant information:
60+
[Screenshots, examples, etc.]
61+
validations:
62+
required: false

0 commit comments

Comments
 (0)