python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2025-12-06 07:50:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve issue and pull request templates (#947)

Browse source 
Start using forms instead of templates
This commit is contained in:
Evgen Fil 2022-06-26 18:27:42 +05:00 • committed by GitHub
parent b5100587e6
commit b3263f9d6b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 172 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

83
.github/ISSUE_TEMPLATE/bug.yaml vendored Normal file
View file

@ -0,0 +1,83 @@
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: textarea
attributes:
label: Context
description: |
Please provide as much information as possible. This will help us to reproduce the issue and fix it.
value: |
- Operating system: e.g. Ubuntu 20.04.2 LTS
- Python Version: e.g. 3.10.1
- aiogram version: e.g. 2.21 or 3.0b3
- aiohttp version: e.g. 3.8.1
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
View file

@ -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
View 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.

44
.github/ISSUE_TEMPLATE/feature.yaml vendored Normal file
View file

@ -0,0 +1,44 @@
name: Feature request
description: Report features you would like to see or improve in the framework.
labels:
- enhancement
body:
- 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
View file

@ -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.

51
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -1,35 +1,52 @@
# Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
<!--
Please include a summary of the change.
Fixes # (issue)
e.g. Add a new awesome feature or Fix documentation typo.
Please also include relevant motivation and context.
If you are fixing an issue, specify what issue is fixed.
e.g. Fix #12345
-->
Type here...
## Type of change
<!--
Please delete options that are not relevant.
-->
- [ ] Documentation (typos, code examples or any documentation update)
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
- Bug fix (non-breaking change that fixes an issue)
- New feature (non-breaking change that adds functionality)
- Documentation (typos, code examples or any documentation update)
# How Has This Been Tested?
# How has this been tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
<!--
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
Please also list any relevant details for your test configuration.
-->
- [ ] Test A
- [ ] Test B
Type here...
**Test Configuration**:
* Operating System:
* Python version:
## Test Configuration
- Operating system: e.g. Ubuntu 20.04.2 LTS
-Python version: e.g. 3.10.1
# Checklist:
<!--
Please delete options that are not relevant to your change.
-->
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added tests that prove my fix is effective or that my feature works as expected
- [ ] New and existing unit tests pass locally with my changes
- [ ] My changes generate no new warnings or errors
- [ ] My changes are compatible with minimum requirements of the project
- [ ] I have made corresponding changes to the documentation