Skip to content

Commit 1b29c60

Browse files
committed
Update bugreport issue template
1 parent 020f040 commit 1b29c60

File tree

2 files changed

+93
-58
lines changed

2 files changed

+93
-58
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

-58
This file was deleted.

.github/ISSUE_TEMPLATE/bugreport.yml

+93
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
name: Bug Report
2+
description: File a bug report
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
We don't use this issue tracker to help users.
8+
Please use this tracker only when you are sure about it is an issue of this software.
9+
10+
If you had trouble, please ask it on some user community.
11+
12+
- [Python Discord](https://www.pythondiscord.com/)
13+
For general Python questions, including developing application using MySQL.
14+
15+
- [MySQL Community Slack](https://lefred.be/mysql-community-on-slack/)
16+
For general MySQL questions.
17+
18+
- [mysqlclient Discuss](https://github.com/PyMySQL/mysqlclient/discussions)
19+
For mysqlclient specific topics.
20+
21+
- type: textarea
22+
id: describe
23+
attributes:
24+
label: Describe the bug
25+
description: "A **clear and concise** description of what the bug is."
26+
27+
- type: textarea
28+
id: environments
29+
attributes:
30+
label: Environment
31+
description: |
32+
- Server and version (e.g. MySQL 8.0.33, MariaDB 10.11.4)
33+
- OS (e.g. Windows 11, Ubuntu 22.04, macOS 13.4.1)
34+
- Python version
35+
36+
- type: input
37+
id: libmysqlclient
38+
attributes:
39+
label: How did you install libmysqlclient libraries?
40+
description: |
41+
e.g. brew install mysql-cleint, brew install mariadb, apt-get install libmysqlclient-dev
42+
43+
- type: input
44+
id: mysqlclient-version
45+
attributes:
46+
label: What version of mysqlclient do you use?
47+
48+
- type: markdown
49+
attributes:
50+
value: |
51+
## Complete step to reproduce.
52+
#
53+
Do not expect maintainer complement any piece of code, schema, and data need to reproduce.
54+
You need to provide **COMPLETE** step to reproduce.
55+
56+
It is very recommended to use Docker to start MySQL server.
57+
Maintainer can not use your Database to reproduce your issue.
58+
59+
**If you write only little code snippet, maintainer may close your issue
60+
without any comment.**
61+
62+
- type: textarea
63+
id: reproduce-docker
64+
attributes:
65+
label: Docker command to start MySQL server
66+
render: bash
67+
description: e.g. `docker run -e MYSQL_ALLOW_EMPTY_PASSWORD=yes -p 3306:3306 --rm --name mysql mysql:8.0`
68+
69+
- type: textarea
70+
id: reproduce-code
71+
attributes:
72+
label: Minimum but complete code to reproduce
73+
render: python
74+
value: |
75+
# Write Python code here.
76+
import MySQLdb
77+
78+
conn = MySQLdb.connect(host='127.0.0.1', port=3306, user='root')
79+
...
80+
81+
- type: textarea
82+
id: reproduce-schema
83+
attributes:
84+
label: Schema and initial data required to reproduce.
85+
render: sql
86+
value: |
87+
-- Write SQL here.
88+
-- e.g. CREATE TABLE ...
89+
90+
- type: textarea
91+
id: reproduce-other
92+
attributes:
93+
label: Commands, and any other step required to reproduce your issue.

0 commit comments

Comments
 (0)