From 6acc39ac04880645851cc5bd10d0be5497fe427b Mon Sep 17 00:00:00 2001 From: novenary Date: Mon, 29 May 2023 21:29:26 +0300 Subject: [PATCH] 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 --- .github/ISSUE_TEMPLATE/bug-report.md | 29 -------- .github/ISSUE_TEMPLATE/bug-report.yml | 96 +++++++++++++++++++++++++++ 2 files changed, 96 insertions(+), 29 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 9420f6d8..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -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** - - -* [ ] 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 - -``` diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..2541bafb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -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 + + ``` + + - 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