mirror of
https://github.com/LonamiWebs/Telethon.git
synced 2024-11-10 19:46:36 +03:00
Change bug report template to an issue form
Lifted from Tachiyomi and adapted for Telethon. See: https://github.com/tachiyomiorg/tachiyomi/blob/master/.github/ISSUE_TEMPLATE/report_issue.yml
This commit is contained in:
parent
9fe5937ae1
commit
6acc39ac04
29
.github/ISSUE_TEMPLATE/bug-report.md
vendored
29
.github/ISSUE_TEMPLATE/bug-report.md
vendored
|
@ -1,29 +0,0 @@
|
||||||
---
|
|
||||||
name: Bug Report
|
|
||||||
about: Create a report about a bug inside the library or issues with the documentation
|
|
||||||
title: ''
|
|
||||||
labels: ''
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Checklist**
|
|
||||||
|
|
||||||
<!-- Put x inside the boxes (like [x]) to mark them as complete (but only if you've actually completed them!) -->
|
|
||||||
* [ ] The error is in the library's code, and not in my own.
|
|
||||||
* [ ] I have searched for this issue before posting it and there isn't a duplicate.
|
|
||||||
* [ ] I ran `pip install -U https://github.com/LonamiWebs/Telethon/archive/v1.zip` and triggered the bug in the latest version.
|
|
||||||
|
|
||||||
**Code that causes the issue**
|
|
||||||
```python
|
|
||||||
from telethon.sync import TelegramClient
|
|
||||||
...
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
**Traceback**
|
|
||||||
```
|
|
||||||
Traceback (most recent call last):
|
|
||||||
File "code.py", line 1, in <code>
|
|
||||||
|
|
||||||
```
|
|
96
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
96
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
|
@ -0,0 +1,96 @@
|
||||||
|
name: Bug Report
|
||||||
|
description: Create a report about a bug inside the library or issues with the documentation
|
||||||
|
body:
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: reproducing-example
|
||||||
|
attributes:
|
||||||
|
label: Code that causes the issue
|
||||||
|
description: Provide a code example that reproduces the problem.
|
||||||
|
placeholder: |
|
||||||
|
```python
|
||||||
|
from telethon.sync import TelegramClient
|
||||||
|
...
|
||||||
|
|
||||||
|
```
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: expected-behavior
|
||||||
|
attributes:
|
||||||
|
label: Expected behavior
|
||||||
|
description: Explain what you should expect to happen.
|
||||||
|
placeholder: |
|
||||||
|
"This should happen..."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: actual-behavior
|
||||||
|
attributes:
|
||||||
|
label: Actual behavior
|
||||||
|
description: Explain what actually happens.
|
||||||
|
placeholder: |
|
||||||
|
"This happened instead..."
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: traceback
|
||||||
|
attributes:
|
||||||
|
label: Traceback
|
||||||
|
description: |
|
||||||
|
The traceback, if the problem is a crash.
|
||||||
|
placeholder: |
|
||||||
|
```
|
||||||
|
Traceback (most recent call last):
|
||||||
|
File "code.py", line 1, in <code>
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: telethon-version
|
||||||
|
attributes:
|
||||||
|
label: Telethon version
|
||||||
|
placeholder: "1.28.5"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: python-version
|
||||||
|
attributes:
|
||||||
|
label: Python version
|
||||||
|
description: The output of `python3 --version`.
|
||||||
|
placeholder: "3.10.11"
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: input
|
||||||
|
id: os
|
||||||
|
attributes:
|
||||||
|
label: Operating system
|
||||||
|
description: The name and version of your operating system.
|
||||||
|
placeholder: btw i use arch
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: other-details
|
||||||
|
attributes:
|
||||||
|
label: Other details
|
||||||
|
placeholder: |
|
||||||
|
Additional details and attachments.
|
||||||
|
|
||||||
|
- type: checkboxes
|
||||||
|
id: checklist
|
||||||
|
attributes:
|
||||||
|
label: Checklist
|
||||||
|
description: Read this carefully, we will close and ignore your issue if you skimmed through this.
|
||||||
|
options:
|
||||||
|
- label: The error is in the library's code, and not in my own.
|
||||||
|
required: true
|
||||||
|
- label: I have searched for this issue before posting it and there isn't a duplicate.
|
||||||
|
required: true
|
||||||
|
- label: I ran `pip install -U https://github.com/LonamiWebs/Telethon/archive/v1.zip` and triggered the bug in the latest version.
|
||||||
|
required: true
|
Loading…
Reference in New Issue
Block a user