Skip to content

Commit c2141a2

Browse files
committed
Update ISSUE_TEMPLATE
Signed-off-by: Tsuyoshi Hombashi <tsuyoshi.hombashi@gmail.com>
1 parent 5a68db4 commit c2141a2

File tree

5 files changed

+123
-72
lines changed

5 files changed

+123
-72
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

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

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Bug Report
2+
description: Report a bug
3+
title: "[Bug]: "
4+
labels: ["needs-triage"]
5+
body:
6+
- type: input
7+
id: title
8+
attributes:
9+
label: Summary
10+
description: "A brief summary of the bug"
11+
placeholder: "e.g., xxx method raises an exception when yyy"
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: description
17+
attributes:
18+
label: Description
19+
description: "Detailed description of the bug"
20+
placeholder: "A clear and concise description of what the bug is in detail..."
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: expected-behavior
26+
attributes:
27+
label: Expected Behavior
28+
description: "What you expected to happen"
29+
placeholder: "A clear and concise description of what you expected to happen."
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: context
35+
attributes:
36+
label: Context
37+
description: "How has this issue affected you? What are you trying to accomplish?"
38+
placeholder: "Providing context helps us come up with a solution that is most useful in the real world"
39+
validations:
40+
required: false
41+
42+
- type: textarea
43+
id: possible-solution
44+
attributes:
45+
label: Possible Solution
46+
description: "Optional: suggest a fix/reason for the bug or ideas on how to implement the addition or change"
47+
validations:
48+
required: false
49+
50+
- type: textarea
51+
id: code-to-reproduce
52+
attributes:
53+
label: Code to reproduce
54+
description: "How to reproduce the bug with code"
55+
placeholder: Paste the code that reproduces the bug
56+
render: python
57+
validations:
58+
required: true
59+
60+
- type: textarea
61+
id: environment
62+
attributes:
63+
label: Your Environment
64+
description: "Include as many relevant details about the environment you experienced the bug in"
65+
placeholder: |
66+
Please execute the following command and past the output:
67+
68+
```
69+
pip install envinfopy[markdown]
70+
python -m envinfopy --format=markdown SimpleSQLite sqliteschema
71+
```
72+
validations:
73+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: GitHub Discussions
4+
url: https://github.com/thombashi/SimpleSQLite/discussions
5+
about: Please ask and answer questions here.
6+
- name: Documentation
7+
url: https://simplesqlite.rtfd.io/
8+
about: Please check the documentation before creating an issue.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 24 deletions
This file was deleted.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Feature Request
2+
description: Suggest an idea for this project
3+
title: "[Feature Request]: "
4+
labels: ["needs-triage"]
5+
body:
6+
- type: textarea
7+
id: feature-description
8+
attributes:
9+
label: Feature Description
10+
description: "Is your feature request related to a problem? Please describe."
11+
placeholder: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]"
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: solution-description
17+
attributes:
18+
label: Solution Description
19+
description: "Describe the solution you'd like"
20+
placeholder: "A clear and concise description of what you want to happen."
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: alternatives
26+
attributes:
27+
label: Alternatives
28+
description: "Describe alternatives you've considered"
29+
placeholder: "A clear and concise description of any alternative solutions or features you've considered."
30+
validations:
31+
required: false
32+
33+
- type: textarea
34+
id: additional-context
35+
attributes:
36+
label: Additional Context
37+
description: "Add any other context or screenshots about the feature request here"
38+
placeholder: |
39+
How has this issue affected you? What are you trying to accomplish?
40+
Providing context helps us come up with a solution that is most useful in the real world
41+
validations:
42+
required: false

0 commit comments

Comments
 (0)