Skip to content

Updated Issue Templates #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions .github/DISCUSSION_TEMPLATE/ideas.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
title: "💡 Feature Request: "
labels: ["feature request"]
body:
- type: checkboxes
id: search_discussions
attributes:
label: Is there an existing discussion for this?
description: Please search to see if a discussion already exists for the feature you are requesting. (https://github.com/masterking32/YOUR_MODULE_HERE/discussions).
options:
- label: I have searched the existing discussions
required: true
- type: textarea
id: problem
attributes:
label: Is your feature request related to a problem? Please describe the problem.
description: A clear and concise description of what the problem is.
placeholder: I am trying to do [...] but [...]
validations:
required: false
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: |
A clear and concise description of what you want to happen. Include any alternative solutions you've considered.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Alternatives you've considered
description: |
Add any other context about alternative solutions you've considered.
validations:
required: false
- type: textarea
id: additional_context
attributes:
label: Additional context
description: |
Add any other context or screenshots about the feature request here.

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
145 changes: 145 additions & 0 deletions .github/ISSUE_TEMPLATE/10_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
name: 🐞 Bug Report
description: Report a Bug
body:
- type: checkboxes
attributes:
label: 🔍 Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered (https://github.com/masterking32/YOUR_MODULE_HERE/issues?q=).
options:
- label: I have searched the existing issues
required: true

- type: dropdown
id: custom_changes
attributes:
label: "🔧 Have you made any custom changes to the software?"
options:
- "Yes"
- "No"
validations:
required: true
- type: markdown
attributes:
value: |
If yes, we do not support custom changes. Please revert your changes and check if the issue still exists.

- type: dropdown
id: run_method
attributes:
label: "🚀 How did you run the software?"
options:
- start_linux.sh
- start_windows.bat
- using command line
validations:
required: true

- type: dropdown
id: os
attributes:
label: "🖥️ Operating System"
options:
- Windows
- Android
- Ubuntu
- Debian
- macOS
- Arch Linux
- Fedora
- CentOS
- openSUSE
- Docker
- Other Linux
validations:
required: true

- type: input
id: os_version
attributes:
label: "📝 OS Version"
placeholder: "e.g. Windows 11, Ubuntu 20.04, Debian 12, etc."
validations:
required: true

- type: input
id: python_version
attributes:
label: "🐍 Python Version"
placeholder: "e.g. 3.13"
validations:
required: true

- type: dropdown
id: multiple_python
attributes:
label: "🐍 Do you have multiple Python versions installed on your system?"
options:
- "Yes"
- "No"
validations:
required: true
- type: markdown
attributes:
value: |
If yes, please try running the software on a system with only one Python version installed.

- type: dropdown
id: is_http_error
attributes:
label: "🌐 Is this issue related to an HTTP error?"
options:
- "Yes"
- "No"
validations:
required: true
- type: markdown
attributes:
value: |
If yes, please first check if the issue is related to the server. If the server is down or under maintenance, the software will not work. Then try with a different network or Proxy/VPN and check if the issue still exists.

- type: dropdown
id: is_pyrogram_telethon_error
attributes:
label: "📡 Is this issue related to Pyrogram or Telethon?"
options:
- "Yes"
- "No"
validations:
required: true
- type: markdown
attributes:
value: |
If yes, please first check if the issue is related to the library. Please check the library's documentation and issues.

- type: textarea
attributes:
label: 🐛 Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
attributes:
label: 🎯 Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: false

- type: textarea
attributes:
label: 🔄 Steps To Reproduce
description: |
We will close this issue if:
- We are not able to reproduce the behavior you're reporting.
validations:
required: false

- type: textarea
attributes:
label: 💬 Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Feature Request
url: https://github.com/masterking32/YOUR_MODULE_HERE/discussions/new?category=ideas
about: Please use this to request a new feature.
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/custom.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.