Skip to content

Commit bc7c422

Browse files
abxhrabxhr
authored
Create Issue Template Forms (python-telegram-bot#2689)
1 parent c3e3bb7 commit bc7c422

7 files changed

Lines changed: 182 additions & 96 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: Bug Report
2+
description: Create a report to help us improve
3+
title: "[BUG]"
4+
labels: ["bug :bug:"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for reporting issues of python-telegram-bot!
11+
12+
Use this template to notify us if you found a bug.
13+
14+
To make it easier for us to help you please enter detailed information below.
15+
16+
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.
17+
18+
- type: textarea
19+
id: steps-to-reproduce
20+
attributes:
21+
label: Steps to Reproduce
22+
value: |
23+
1.
24+
2.
25+
3.
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: expected-behaviour
31+
attributes:
32+
label: Expected behaviour
33+
description: Tell us what should happen
34+
validations:
35+
required: true
36+
37+
- type: textarea
38+
id: actual-behaviour
39+
attributes:
40+
label: Actual behaviour
41+
description: Tell us what happens instead
42+
validations:
43+
required: true
44+
45+
- type: markdown
46+
attributes:
47+
value: "### Configuration"
48+
49+
- type: input
50+
id: operating-system
51+
attributes:
52+
label: Operating System
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: versions
58+
attributes:
59+
label: Version of Python, python-telegram-bot & dependencies
60+
description: Paste the output of `$ python -m telegram` here. This will be automatically formatted into code, so no need for backticks.
61+
render: shell
62+
validations:
63+
required: true
64+
65+
- type: textarea
66+
id: logs
67+
attributes:
68+
label: Relevant log output
69+
description: Insert logs here (if necessary). This will be automatically formatted into code, so no need for backticks.
70+
render: python
71+
72+
- type: textarea
73+
id: additional-context
74+
attributes:
75+
label: Additional Context
76+
description: You may provide any other additional context to the bug here.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 43 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature-request.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
title: "[FEATURE]"
4+
labels: ["enhancement"]
5+
6+
body:
7+
- type: textarea
8+
id: related-problem
9+
attributes:
10+
label: "What kind of feature are you missing? Where do you notice a shortcoming of PTB?"
11+
description: "A clear and concise description of what the problem is."
12+
placeholder: "Example: I want to do X, but there is no way to do it."
13+
validations:
14+
required: true
15+
16+
- type: textarea
17+
id: solution
18+
attributes:
19+
label: "Describe the solution you'd like"
20+
description: "A clear and concise description of what you want to happen."
21+
placeholder: "Example: I think it would be nice if you would add feature Y so I can do X."
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: alternatives
27+
attributes:
28+
label: "Describe alternatives you've considered"
29+
description: "A clear and concise description of any alternative solutions or features you've considered."
30+
placeholder: "Example: I considered Z to be able to do X, but that didn't work because..."
31+
32+
- type: textarea
33+
id: additional-context
34+
attributes:
35+
label: "Additional context"
36+
description: "Add any other context or screenshots about the feature request here."
37+
placeholder: "Example: Here's a photo of my cat!"

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 0 additions & 29 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Question
2+
description: Get help with errors or general questions
3+
title: "[QUESTION]"
4+
labels: ["question"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Hey there, you have a question? We are happy to answer. Please make sure no similar question was opened already.
11+
12+
To make it easier for us to help you, please read this [article](https://git.io/JURJO).
13+
14+
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.
15+
16+
- type: textarea
17+
id: issue-faced
18+
attributes:
19+
label: "Issue I am facing"
20+
description: "Please describe the issue here in as much detail as possible"
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: traceback
26+
attributes:
27+
label: "Traceback to the issue"
28+
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."
29+
placeholder: |
30+
Traceback (most recent call last):
31+
File "/home/bot.py", line 1, in main
32+
foo = bar()
33+
...
34+
telegram.error.BadRequest: Traceback not found
35+
render: python
36+
37+
- type: textarea
38+
id: related-code
39+
attributes:
40+
label: "Related part of your code"
41+
description: "This will be automatically formatted into code (python), so no need for backticks."
42+
placeholder: |
43+
logging.basicConfig(
44+
format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO
45+
)
46+
47+
logger = logging.getLogger(__name__)
48+
render: python
49+
50+
- type: markdown
51+
attributes:
52+
value: "### Configuration"
53+
54+
- type: input
55+
id: operating-system
56+
attributes:
57+
label: Operating System
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: versions
63+
attributes:
64+
label: Version of Python, python-telegram-bot & dependencies
65+
description: Paste the output of `$ python -m telegram` here. This will be automatically formatted into code, so no need for backticks.
66+
render: shell
67+
validations:
68+
required: true

‎AUTHORS.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Contributors
2626

2727
The following wonderful people contributed directly or indirectly to this project:
2828

29+
- `Abshar <https://github.com/abxhr>`_
2930
- `Alateas <https://github.com/alateas>`_
3031
- `Ales Dokshanin <https://github.com/alesdokshanin>`_
3132
- `Ambro17 <https://github.com/Ambro17>`_

0 commit comments

Comments
 (0)