Skip to content

Commit b60bb7d

Browse files
committed
create bug report and feature request templates
1 parent 6fdae7a commit b60bb7d

File tree

2 files changed

+103
-0
lines changed

2 files changed

+103
-0
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: 'Bug Report'
2+
description: 'Report a bug to help us improve this project'
3+
labels:
4+
- 'kind/bug'
5+
- 'status/need-triage'
6+
body:
7+
- type: 'markdown'
8+
attributes:
9+
value: |-
10+
> [!IMPORTANT]
11+
> Thanks for taking the time to fill out this bug report!
12+
>
13+
> Please search **[existing issues](./issues)** to see if an issue already exists for the bug you encountered.
14+
15+
- type: 'textarea'
16+
id: 'problem'
17+
attributes:
18+
label: 'What happened?'
19+
description: 'A clear and concise description of what the bug is.'
20+
validations:
21+
required: true
22+
23+
- type: 'textarea'
24+
id: 'expected'
25+
attributes:
26+
label: 'What did you expect to happen?'
27+
validations:
28+
required: true
29+
30+
- type: 'textarea'
31+
id: 'reproduction'
32+
attributes:
33+
label: 'Steps to reproduce'
34+
description: 'List the steps to reproduce the issue. Include commands, inputs, and observed output.'
35+
value: |-
36+
1.
37+
2.
38+
3.
39+
40+
- type: 'textarea'
41+
id: 'environment'
42+
attributes:
43+
label: 'Environment details'
44+
description: 'OS, runtime, tool versions, and any other relevant environment info.'
45+
value: |-
46+
<details>
47+
<summary>Environment</summary>
48+
49+
- OS:
50+
- Shell:
51+
- Node/Python/Go/etc. versions:
52+
- Tool/CLI version:
53+
54+
</details>
55+
56+
- type: 'textarea'
57+
id: 'additional-context'
58+
attributes:
59+
label: 'Anything else we need to know?'
60+
description: 'Logs, screenshots, or other context that helps diagnose the problem.'
61+
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+
labels:
4+
- 'kind/enhancement'
5+
- 'status/need-triage'
6+
body:
7+
- type: 'markdown'
8+
attributes:
9+
value: |-
10+
> [!IMPORTANT]
11+
> Thanks for taking the time to suggest an enhancement!
12+
>
13+
> Please search **[existing issues](./issues)** to see if a similar feature has already been requested.
14+
15+
- type: 'textarea'
16+
id: 'feature'
17+
attributes:
18+
label: 'What would you like to be added?'
19+
description: 'A clear and concise description of the enhancement.'
20+
validations:
21+
required: true
22+
23+
- type: 'textarea'
24+
id: 'rationale'
25+
attributes:
26+
label: 'Why is this needed?'
27+
description: 'A clear and concise description of why this enhancement is needed.'
28+
validations:
29+
required: true
30+
31+
- type: 'textarea'
32+
id: 'solution-ideas'
33+
attributes:
34+
label: 'Possible solution or alternatives'
35+
description: 'If you have ideas for how to implement it, or alternatives you considered, add them here.'
36+
37+
- type: 'textarea'
38+
id: 'additional-context'
39+
attributes:
40+
label: 'Additional context'
41+
description: 'Add any other context or screenshots about the feature request here.'
42+

0 commit comments

Comments
 (0)