From bc7c422a11a60a3064601aac3fd5a26fd9b45ae9 Mon Sep 17 00:00:00 2001 From: Abshar Mohammed Aslam Date: Sun, 3 Oct 2021 22:08:04 +0400 Subject: [PATCH] Create Issue Template Forms (#2689) --- .github/ISSUE_TEMPLATE/bug-report.yml | 76 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 43 ------------ .github/ISSUE_TEMPLATE/feature-request.yml | 37 +++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 ------- .github/ISSUE_TEMPLATE/question.md | 29 --------- .github/ISSUE_TEMPLATE/question.yml | 68 +++++++++++++++++++ AUTHORS.rst | 1 + 7 files changed, 182 insertions(+), 96 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..509f689df --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,76 @@ +name: Bug Report +description: Create a report to help us improve +title: "[BUG]" +labels: ["bug :bug:"] + +body: + - type: markdown + attributes: + value: | + Thanks for reporting issues of python-telegram-bot! + + Use this template to notify us if you found a bug. + + To make it easier for us to help you please enter detailed information below. + + Please note, we only support the latest version of python-telegram-bot and master branch. Please make sure to upgrade & recreate the issue on the latest version prior to opening an issue. + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + value: | + 1. + 2. + 3. + validations: + required: true + + - type: textarea + id: expected-behaviour + attributes: + label: Expected behaviour + description: Tell us what should happen + validations: + required: true + + - type: textarea + id: actual-behaviour + attributes: + label: Actual behaviour + description: Tell us what happens instead + validations: + required: true + + - type: markdown + attributes: + value: "### Configuration" + + - type: input + id: operating-system + attributes: + label: Operating System + validations: + required: true + + - type: textarea + id: versions + attributes: + label: Version of Python, python-telegram-bot & dependencies + description: Paste the output of `$ python -m telegram` here. This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Insert logs here (if necessary). This will be automatically formatted into code, so no need for backticks. + render: python + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: You may provide any other additional context to the bug here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 1b32e8050..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG]" -labels: 'bug :bug:' -assignees: '' - ---- - - -### Steps to reproduce -1. - -2. - -3. - -### Expected behaviour -Tell us what should happen - -### Actual behaviour -Tell us what happens instead - -### Configuration -**Operating System:** - - -**Version of Python, python-telegram-bot & dependencies:** - -``$ python -m telegram`` - -### Logs -Insert logs here (if necessary) diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..6c7ff8039 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,37 @@ +name: Feature Request +description: Suggest an idea for this project +title: "[FEATURE]" +labels: ["enhancement"] + +body: + - type: textarea + id: related-problem + attributes: + label: "What kind of feature are you missing? Where do you notice a shortcoming of PTB?" + description: "A clear and concise description of what the problem is." + placeholder: "Example: I want to do X, but there is no way to do it." + validations: + required: true + + - type: textarea + id: solution + attributes: + label: "Describe the solution you'd like" + description: "A clear and concise description of what you want to happen." + placeholder: "Example: I think it would be nice if you would add feature Y so I can do X." + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: "Describe alternatives you've considered" + description: "A clear and concise description of any alternative solutions or features you've considered." + placeholder: "Example: I considered Z to be able to do X, but that didn't work because..." + + - type: textarea + id: additional-context + attributes: + label: "Additional context" + description: "Add any other context or screenshots about the feature request here." + placeholder: "Example: Here's a photo of my cat!" diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 0eef7caf9..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[FEATURE]" -labels: enhancement -assignees: '' - ---- - -#### Is your feature request related to a problem? Please describe. -A clear and concise description of what the problem is. -Ex. *I want to do X, but there is no way to do it.* - -#### Describe the solution you'd like -A clear and concise description of what you want to happen. -Ex. *I think it would be nice if you would add feature Y so it will make it easier.* - -#### Describe alternatives you've considered -A clear and concise description of any alternative solutions or features you've considered. -Ex. *I considered Z, but that didn't work because...* - -#### Additional context -Add any other context or screenshots about the feature request here. -Ex. *Here's a photo of my cat!* diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index cf0b9489a..000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -name: Question -about: Get help with errors or general questions -title: "[QUESTION]" -labels: question -assignees: '' - ---- - - - -### Issue I am facing -Please describe the issue here in as much detail as possible - -### Traceback to the issue -``` -put it here -``` - -### Related part of your code -```python -put it here -``` diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 000000000..84b686d10 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,68 @@ +name: Question +description: Get help with errors or general questions +title: "[QUESTION]" +labels: ["question"] + +body: + - type: markdown + attributes: + value: | + Hey there, you have a question? We are happy to answer. Please make sure no similar question was opened already. + + To make it easier for us to help you, please read this [article](https://git.io/JURJO). + + Please mind that there is also a users' [Telegram group](https://t.me/pythontelegrambotgroup) for questions about the library. Questions asked there might be answered quicker than here. Moreover, [GitHub Discussions](https://git.io/JG3rk) offer a slightly better format to discuss usage questions. + + - type: textarea + id: issue-faced + attributes: + label: "Issue I am facing" + description: "Please describe the issue here in as much detail as possible" + validations: + required: true + + - type: textarea + id: traceback + attributes: + label: "Traceback to the issue" + description: "If you are facing a specific error message, please paste the traceback here. This will be automatically formatted into python code, so no need for backticks." + placeholder: | + Traceback (most recent call last): + File "/home/bot.py", line 1, in main + foo = bar() + ... + telegram.error.BadRequest: Traceback not found + render: python + + - type: textarea + id: related-code + attributes: + label: "Related part of your code" + description: "This will be automatically formatted into code (python), so no need for backticks." + placeholder: | + logging.basicConfig( + format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO + ) + + logger = logging.getLogger(__name__) + render: python + + - type: markdown + attributes: + value: "### Configuration" + + - type: input + id: operating-system + attributes: + label: Operating System + validations: + required: true + + - type: textarea + id: versions + attributes: + label: Version of Python, python-telegram-bot & dependencies + description: Paste the output of `$ python -m telegram` here. This will be automatically formatted into code, so no need for backticks. + render: shell + validations: + required: true diff --git a/AUTHORS.rst b/AUTHORS.rst index dbefd1bd1..cde16caa0 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -26,6 +26,7 @@ Contributors The following wonderful people contributed directly or indirectly to this project: +- `Abshar `_ - `Alateas `_ - `Ales Dokshanin `_ - `Ambro17 `_