Skip to content

Commit f8dc600

Browse files
authored
create bug report template, based on aiohttp bug report template (#661)
1 parent 4274fbc commit f8dc600

File tree

1 file changed

+114
-0
lines changed

1 file changed

+114
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
---
2+
name: Bug Report
3+
description: Create a report to help us improve.
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**Thanks for taking a minute to file a bug report!**
10+
11+
12+
Verify first that your issue is not [already reported on
13+
GitHub][issue search].
14+
15+
_Please fill out the form below with as many precise
16+
details as possible._
17+
18+
[issue search]: ../search?q=is%3Aissue&type=issues
19+
20+
- type: textarea
21+
attributes:
22+
label: Describe the bug
23+
description: >-
24+
A clear and concise description of what the bug is.
25+
validations:
26+
required: true
27+
28+
- type: textarea
29+
attributes:
30+
label: To Reproduce
31+
description: >-
32+
Describe the steps to reproduce this bug.
33+
placeholder: |
34+
1. Have certain environment
35+
2. Then run '...'
36+
3. An error occurs.
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
attributes:
42+
label: Expected behavior
43+
description: >-
44+
A clear and concise description of what you expected to happen.
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
attributes:
50+
label: Logs/tracebacks
51+
description: |
52+
If applicable, add logs/tracebacks to help explain your problem.
53+
Paste the output of the steps above, including the commands
54+
themselves and their output/traceback etc.
55+
render: python-traceback
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
attributes:
61+
label: Python Version
62+
description: Attach your version of Python.
63+
render: console
64+
value: |
65+
$ python --version
66+
validations:
67+
required: true
68+
- type: textarea
69+
attributes:
70+
label: aiomysql Version
71+
description: Attach your version of aiomysql.
72+
render: console
73+
value: |
74+
$ python -m pip show aiomysql
75+
validations:
76+
required: true
77+
78+
- type: textarea
79+
attributes:
80+
label: OS
81+
placeholder: >-
82+
For example, Arch Linux, Windows, macOS, etc.
83+
validations:
84+
required: true
85+
86+
- type: textarea
87+
attributes:
88+
label: Database type and version
89+
description: Attach your version of MariaDB/MySQL.
90+
render: console
91+
value: |
92+
SELECT VERSION();
93+
validations:
94+
required: true
95+
96+
- type: textarea
97+
attributes:
98+
label: Additional context
99+
description: |
100+
Add any other context about the problem here.
101+
102+
Describe the environment you have that lead to your issue.
103+
104+
- type: checkboxes
105+
attributes:
106+
label: Code of Conduct
107+
description: |
108+
Read the [aio-libs Code of Conduct][CoC] first.
109+
110+
[CoC]: https://github.com/aio-libs/.github/blob/master/CODE_OF_CONDUCT.md
111+
options:
112+
- label: I agree to follow the aio-libs Code of Conduct
113+
required: true
114+
...

0 commit comments

Comments
 (0)