Skip to content

Commit 9d74aea

Browse files
chore: issue forms with reason-listings (#3476)
* feat: added a draft of an issue form * fixed a validation issue * finished up the templates * used austins phrasing * Applied comments from the code review Co-authored-by: Austin Bonander <[email protected]> * Applyed more suggestions from code review Co-authored-by: Austin Bonander <[email protected]> * Broke the environment up into multiple fields * boiled the FR-fields down to a description and an breaking change field * fixed an unique id issue --------- Co-authored-by: Austin Bonander <[email protected]>
1 parent 28cfdbb commit 9d74aea

File tree

4 files changed

+98
-39
lines changed

4 files changed

+98
-39
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

-19
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: I think I found a bug in SQLx
2+
description: Create a bug-report issue
3+
labels: [bug]
4+
body:
5+
- type: textarea
6+
id: related-issues
7+
validations:
8+
required: true
9+
attributes:
10+
label: I have found these related issues/pull requests
11+
description: |
12+
I have searched by clicking [HERE](https://github.com/launchbadge/sqlx/issues?q=)
13+
for existing issues, these are the ones I've found,
14+
and this is why I think this deserves a new issue.
15+
placeholder: "Related to ..."
16+
- type: textarea
17+
id: description
18+
validations:
19+
required: true
20+
attributes:
21+
label: Description
22+
description: Clear and concise description of what the bug is
23+
- type: textarea
24+
id: steps-to-reproduce
25+
validations:
26+
required: true
27+
attributes:
28+
label: Reproduction steps
29+
description: A small code snippet or a link to a Github repo or Gist, with instructions on reproducing the bug.
30+
- type: input
31+
id: sqlx-version
32+
attributes:
33+
label: SQLx version
34+
validations:
35+
required: true
36+
- type: input
37+
id: sqlx-features
38+
attributes:
39+
label: Enabled SQLx features
40+
validations:
41+
required: true
42+
- type: input
43+
id: db-server-and-version
44+
attributes:
45+
label: Database server and version
46+
placeholder: MySQL / Postgres / SQLite <x.y.z>
47+
validations:
48+
required: true
49+
- type: input
50+
id: os-type
51+
attributes:
52+
label: Operating system
53+
validations:
54+
required: true
55+
- type: input
56+
id: rust-version
57+
attributes:
58+
label: Rust version
59+
description: You can get this via running `rustc --version`
60+
validations:
61+
required: true

.github/ISSUE_TEMPLATE/feature_request.md

-20
This file was deleted.
+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: I have a feature request for SQLx
2+
description: Create a feature-request issue
3+
labels: [enhancement]
4+
body:
5+
- type: textarea
6+
id: related-issues
7+
validations:
8+
required: true
9+
attributes:
10+
label: I have found these related issues/pull requests
11+
description: "Provide context for your pull request."
12+
placeholder: |
13+
Closes \#...
14+
Relates to \#...
15+
- type: textarea
16+
id: feature-description
17+
validations:
18+
required: true
19+
attributes:
20+
label: Description
21+
description: A clear and concise description of what the problem is
22+
placeholder: You should add ...
23+
- type: textarea
24+
id: solution
25+
validations:
26+
required: true
27+
attributes:
28+
label: Prefered solution
29+
description: A clear and concise description of what you want to happen.
30+
placeholder: In my use-case, ...
31+
- type: textarea
32+
id: breaking-change
33+
validations:
34+
required: true
35+
attributes:
36+
label: Is this a breaking change? Why or why not?
37+

0 commit comments

Comments
 (0)