mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
Backport issue templates
This commit is contained in:
parent
56e969660e
commit
7adc39bd82
5 changed files with 164 additions and 62 deletions
98
.github/ISSUE_TEMPLATE/bug.yaml
vendored
Normal file
98
.github/ISSUE_TEMPLATE/bug.yaml
vendored
Normal file
|
|
@ -0,0 +1,98 @@
|
||||||
|
name: Bug report
|
||||||
|
description: Report issues affecting the framework or the documentation.
|
||||||
|
labels:
|
||||||
|
- bug
|
||||||
|
body:
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Checklist
|
||||||
|
options:
|
||||||
|
- label: I am sure the error is coming from aiogram code
|
||||||
|
required: true
|
||||||
|
- label: I have searched in the issue tracker for similar bug reports, including closed ones
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: markdown
|
||||||
|
attributes:
|
||||||
|
value: |
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Please provide as much information as possible. This will help us to reproduce the issue and fix it.
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Operating system
|
||||||
|
placeholder: e.g. Ubuntu 20.04.2 LTS
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Python version
|
||||||
|
placeholder: e.g. 3.10.1
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: aiogram version
|
||||||
|
placeholder: e.g. 2.21 or 3.0b3
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Expected behavior
|
||||||
|
description: Please describe the behavior you are expecting.
|
||||||
|
placeholder: E.g. the bot should send a message with the text "Hello, world!".
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Current behavior
|
||||||
|
description: Please describe the behavior you are currently experiencing.
|
||||||
|
placeholder: E.g. the bot doesn't send any message.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Steps to reproduce
|
||||||
|
description: Please describe the steps you took to reproduce the behavior.
|
||||||
|
placeholder: |
|
||||||
|
1. step 1
|
||||||
|
2. step 2
|
||||||
|
3. ...
|
||||||
|
4. you get it...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Code example
|
||||||
|
description: Provide a [minimal, reproducible](https://stackoverflow.com/help/minimal-reproducible-example) and properly formatted example (if applicable).
|
||||||
|
placeholder: |
|
||||||
|
from aiogram import Bot, Dispatcher
|
||||||
|
...
|
||||||
|
render: python3
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Logs
|
||||||
|
description: Provide the complete traceback (if applicable) or other kind of logs.
|
||||||
|
placeholder: |
|
||||||
|
Traceback (most recent call last):
|
||||||
|
File "main.py", line 1, in <module>
|
||||||
|
...
|
||||||
|
SomeException: ...
|
||||||
|
render: sh
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Additional information
|
||||||
|
description: Please provide any additional information that may help us to reproduce the issue.
|
||||||
|
placeholder: |
|
||||||
|
E.g. this behavior is reproducible only in group chats.
|
||||||
|
|
||||||
|
You can also attach additional screenshots, logs, or other files.
|
||||||
45
.github/ISSUE_TEMPLATE/bug_report.md
vendored
45
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -1,45 +0,0 @@
|
||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Create a report to help us improve
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Create a report to help us improve
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Context
|
|
||||||
|
|
||||||
Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions.
|
|
||||||
|
|
||||||
* Operating System:
|
|
||||||
* Python Version:
|
|
||||||
* aiogram version:
|
|
||||||
* aiohttp version:
|
|
||||||
* uvloop version (if installed):
|
|
||||||
|
|
||||||
## Expected Behavior
|
|
||||||
|
|
||||||
Please describe the behavior you are expecting
|
|
||||||
|
|
||||||
## Current Behavior
|
|
||||||
|
|
||||||
What is the current behavior?
|
|
||||||
|
|
||||||
## Failure Information (for bugs)
|
|
||||||
|
|
||||||
Please help provide information about the failure if this is a bug. If it is not a bug, please remove the rest of this template.
|
|
||||||
|
|
||||||
### Steps to Reproduce
|
|
||||||
|
|
||||||
Please provide detailed steps for reproducing the issue.
|
|
||||||
|
|
||||||
1. step 1
|
|
||||||
2. step 2
|
|
||||||
3. you get it...
|
|
||||||
|
|
||||||
### Failure Logs
|
|
||||||
|
|
||||||
Please include any relevant log snippets or files here.
|
|
||||||
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
blank_issues_enabled: true
|
||||||
|
contact_links:
|
||||||
|
- name: Discuss anything related to the framework
|
||||||
|
url: https://github.com/aiogram/aiogram/discussions
|
||||||
|
about: Ask a question about aiogram or share your code snippets and ideas.
|
||||||
|
- name: Join our Telegram channel
|
||||||
|
url: https://t.me/aiogram_live
|
||||||
|
about: Get the latest updates about the framework.
|
||||||
|
- name: Join our Telegram chat
|
||||||
|
url: https://t.me/aiogram
|
||||||
|
about: Get help, ask questions, and discuss the framework in real-time.
|
||||||
55
.github/ISSUE_TEMPLATE/feature.yaml
vendored
Normal file
55
.github/ISSUE_TEMPLATE/feature.yaml
vendored
Normal file
|
|
@ -0,0 +1,55 @@
|
||||||
|
name: Feature request
|
||||||
|
description: Report features you would like to see or improve in the framework.
|
||||||
|
labels:
|
||||||
|
- enhancement
|
||||||
|
body:
|
||||||
|
- type: dropdown
|
||||||
|
attributes:
|
||||||
|
label: aiogram version
|
||||||
|
options:
|
||||||
|
- 2.x
|
||||||
|
- 3.x
|
||||||
|
- both
|
||||||
|
- n/a
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Problem
|
||||||
|
description: Is your feature request related to a specific problem? If not, please describe the general idea of your request.
|
||||||
|
placeholder: e.g. I want to send a photo to a user by url.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Possible solution
|
||||||
|
description: Describe the solution you would like to see in the framework.
|
||||||
|
placeholder: e.g. Add a method to send a photo to a user by url.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Alternatives
|
||||||
|
description: What other solutions do you have in mind?
|
||||||
|
placeholder: e.g. I'm sending a text message with photo url.
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Code example
|
||||||
|
description: A small code example that demonstrates the behavior you would like to see.
|
||||||
|
placeholder: |
|
||||||
|
await bot.send_photo(user_id, photo_url)
|
||||||
|
...
|
||||||
|
render: python3
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Additional information
|
||||||
|
description: Any additional information you would like to provide.
|
||||||
|
placeholder: |
|
||||||
|
E.g. this method should also cache images to speed up further sending.
|
||||||
|
|
||||||
|
You can also attach additional pictures or other files.
|
||||||
17
.github/ISSUE_TEMPLATE/feature_request.md
vendored
17
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
|
@ -1,17 +0,0 @@
|
||||||
---
|
|
||||||
name: Feature request
|
|
||||||
about: Suggest an idea for this project
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Is your feature request related to a problem? Please describe.**
|
|
||||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
|
||||||
|
|
||||||
**Describe the solution you'd like**
|
|
||||||
A clear and concise description of what you want to happen.
|
|
||||||
|
|
||||||
**Describe alternatives you've considered**
|
|
||||||
A clear and concise description of any alternative solutions or features you've considered.
|
|
||||||
|
|
||||||
**Additional context**
|
|
||||||
Add any other context or screenshots about the feature request here.
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue