Skip to content

Commit e6d9a2a

Browse files
authored
chore: use form based issue templates (delta-io#3865)
# Description To help our users and us to gather some more structured context about issues and features requests, this PR switches us to the more modern form based issue templates. This also allows us to handle some metadata (e.g. issue type) in a consistent manner. Signed-off-by: Robert Pack <robstar.pack@gmail.com>
1 parent dfe4cfc commit e6d9a2a

4 files changed

Lines changed: 157 additions & 39 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 27 deletions
This file was deleted.
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
name: Bug Report
2+
description: File a bug report to help us improve
3+
title: "[Bug]: "
4+
labels: []
5+
type: Bug
6+
assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for taking the time to fill out this bug report!
12+
13+
- type: textarea
14+
id: what-happened
15+
attributes:
16+
label: What happened?
17+
description: A clear and concise description of what the bug is.
18+
placeholder: Tell us what you see!
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
id: expected
24+
attributes:
25+
label: Expected behavior
26+
description: A clear and concise description of what you expected to happen.
27+
placeholder: What did you expect to happen?
28+
validations:
29+
required: true
30+
31+
- type: dropdown
32+
id: os
33+
attributes:
34+
label: Operating System
35+
description: What operating system are you running?
36+
options:
37+
- Linux
38+
- macOS
39+
- Windows
40+
- Other
41+
validations:
42+
required: false
43+
44+
- type: dropdown
45+
id: binding
46+
attributes:
47+
label: Binding
48+
description: Which language/binding are you using?
49+
options:
50+
- Rust
51+
- Python
52+
validations:
53+
required: false
54+
55+
- type: input
56+
id: version
57+
attributes:
58+
label: Bindings Version
59+
description: What version of the crate are you running?
60+
placeholder: e.g. 0.0.1
61+
validations:
62+
required: false
63+
64+
- type: textarea
65+
id: reproduce
66+
attributes:
67+
label: Steps to reproduce
68+
description: A minimal reproducible example for the bug.
69+
placeholder: |
70+
1. Setup '...'
71+
2. Execute '....'
72+
3. See error
73+
validations:
74+
required: false
75+
76+
- type: textarea
77+
id: logs
78+
attributes:
79+
label: Relevant logs
80+
description: |
81+
Please copy and paste any relevant log output.
82+
This will be automatically formatted into code, so no need for backticks.
83+
render: shell
84+
validations:
85+
required: false

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: []
5+
type: Feature
6+
assignees: []
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for suggesting a new feature! Please provide as much detail as possible to help us understand your request.
12+
13+
- type: textarea
14+
id: problem-description
15+
attributes:
16+
label: Is your feature request related to a problem?
17+
description: A clear and concise description of what the problem is.
18+
placeholder: I'm always frustrated when...
19+
validations:
20+
required: false
21+
22+
- type: textarea
23+
id: solution
24+
attributes:
25+
label: Describe the solution you'd like
26+
description: A clear and concise description of what you want to happen.
27+
placeholder: I would like to see...
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: alternatives
33+
attributes:
34+
label: Describe alternatives you've considered
35+
description: A clear and concise description of any alternative solutions or features you've considered.
36+
placeholder: I've also considered...
37+
validations:
38+
required: false
39+
40+
- type: dropdown
41+
id: priority
42+
attributes:
43+
label: Priority
44+
description: How important is this feature to you?
45+
options:
46+
- Low - Nice to have
47+
- Medium - Would be helpful
48+
- High - Important for my use case
49+
- Critical - Blocking my work
50+
validations:
51+
required: false
52+
53+
- type: textarea
54+
id: additional-context
55+
attributes:
56+
label: Additional context
57+
description: Add any other context or examples about the feature request here.
58+
validations:
59+
required: false
60+
61+
- type: checkboxes
62+
id: contribution
63+
attributes:
64+
label: Contribution
65+
description: Are you willing to contribute to this feature?
66+
options:
67+
- label: I'm willing to submit a pull request for this feature
68+
required: false
69+
- label: I can help with testing this feature
70+
required: false
71+
- label: I can help with documentation for this feature
72+
required: false

0 commit comments

Comments
 (0)