From 6acc39ac04880645851cc5bd10d0be5497fe427b Mon Sep 17 00:00:00 2001 From: novenary Date: Mon, 29 May 2023 21:29:26 +0300 Subject: [PATCH 1/4] 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 From 9751b356fec5e3dc350437114c20508a0b0b72e7 Mon Sep 17 00:00:00 2001 From: novenary Date: Mon, 29 May 2023 21:51:23 +0300 Subject: [PATCH 2/4] Change feature request template to an issue form --- .github/ISSUE_TEMPLATE/feature-request.md | 10 ---------- .github/ISSUE_TEMPLATE/feature-request.yml | 22 ++++++++++++++++++++++ 2 files changed, 22 insertions(+), 10 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index dc38f2db..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Feature Request -about: Suggest ideas, changes or other enhancements for the library -title: '' -labels: enhancement -assignees: '' - ---- - -Please describe your idea. Would you like another friendly method? Renaming them to something more appropriated? Changing the way something works? diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000..68254a35 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,22 @@ +name: Feature Request +description: Suggest ideas, changes or other enhancements for the library. +labels: [enhancement] +body: + + - type: textarea + id: feature-description + attributes: + label: Describe your suggested feature + description: Please describe your idea. Would you like another friendly method? Renaming them to something more appropriate? Changing the way something works? + placeholder: "It should work like this..." + validations: + required: true + + - 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: I have searched for this issue before posting it and there isn't a duplicate. + required: true From ed825a2c7dbe98af0ace3afa474ba4cf4baaa886 Mon Sep 17 00:00:00 2001 From: novenary Date: Mon, 29 May 2023 21:58:28 +0300 Subject: [PATCH 3/4] Add dedicated form for documentation issues --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- .../ISSUE_TEMPLATE/documentation-issue.yml | 22 +++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/documentation-issue.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 2541bafb..6f211caa 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,5 +1,5 @@ name: Bug Report -description: Create a report about a bug inside the library or issues with the documentation +description: Create a report about a bug inside the library. body: - type: textarea diff --git a/.github/ISSUE_TEMPLATE/documentation-issue.yml b/.github/ISSUE_TEMPLATE/documentation-issue.yml new file mode 100644 index 00000000..24fa7d44 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-issue.yml @@ -0,0 +1,22 @@ +name: Documentation Issue +description: Report a problem with the documentation. +labels: [documentation] +body: + + - type: textarea + id: description + attributes: + label: Description + description: Describe the problem in detail. + placeholder: This part is unclear... + + - 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: This is a documentation problem, not a question or a bug report. + required: true + - label: I have searched for this issue before posting it and there isn't a duplicate. + required: true From c89644eec4e66d4de4cdc986f18a297dc8872d70 Mon Sep 17 00:00:00 2001 From: Lonami Date: Wed, 31 May 2023 00:01:16 +0200 Subject: [PATCH 4/4] Update some fields in the GH issue template --- .github/ISSUE_TEMPLATE/bug-report.yml | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 6f211caa..004a727d 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -6,7 +6,7 @@ body: id: reproducing-example attributes: label: Code that causes the issue - description: Provide a code example that reproduces the problem. + description: Provide a code example that reproduces the problem. Try to keep it short without other dependencies. placeholder: | ```python from telethon.sync import TelegramClient @@ -20,9 +20,9 @@ body: id: expected-behavior attributes: label: Expected behavior - description: Explain what you should expect to happen. + description: Explain what you should expect to happen. Include reproduction steps. placeholder: | - "This should happen..." + "I was doing... I was expecting the following to happen..." validations: required: true @@ -53,7 +53,8 @@ body: id: telethon-version attributes: label: Telethon version - placeholder: "1.28.5" + description: The output of `python -c "import telethon; print(telethon.__version__)"`. + placeholder: "1.x" validations: required: true @@ -61,8 +62,8 @@ body: id: python-version attributes: label: Python version - description: The output of `python3 --version`. - placeholder: "3.10.11" + description: The output of `python --version`. + placeholder: "3.x" validations: required: true @@ -71,7 +72,7 @@ body: attributes: label: Operating system description: The name and version of your operating system. - placeholder: btw i use arch + placeholder: Windows, Mac, Linux-based distribution... validations: required: true @@ -80,7 +81,7 @@ body: attributes: label: Other details placeholder: | - Additional details and attachments. + Additional details and attachments. Is it a server? Network condition? - type: checkboxes id: checklist @@ -90,7 +91,7 @@ body: 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. + - label: I have searched for this issue before posting it and there isn't an open 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