Skip to content

Commit 7f86c51

Browse files
chore: add bugreport and feature-request templates (#117)
--------- Co-authored-by: xobotyi <[email protected]>
1 parent 8a37fbc commit 7f86c51

File tree

3 files changed

+145
-0
lines changed

3 files changed

+145
-0
lines changed
Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
name: Bug Report
2+
description: File a bug report for exhaustruct analyzer
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report! Please provide as much detail as possible to help us understand and reproduce the issue.
11+
12+
- type: dropdown
13+
id: usage-method
14+
attributes:
15+
label: Usage Method
16+
description: How are you using exhaustruct?
17+
options:
18+
- Command line tool
19+
- golangci-lint integration
20+
- Direct analyzer usage
21+
multiple: true
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: what-happened
27+
attributes:
28+
label: What happened?
29+
description: Describe the bug. What did you expect to happen vs what actually happened?
30+
placeholder: A clear and concise description of what the bug is.
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: reproduction-steps
36+
attributes:
37+
label: Steps to Reproduce
38+
description: How can we reproduce this issue?
39+
placeholder: |
40+
1. Create a Go file with...
41+
2. Run exhaustruct with flags...
42+
3. Expected result vs actual result...
43+
validations:
44+
required: true
45+
46+
- type: textarea
47+
id: code-sample
48+
attributes:
49+
label: Code Sample
50+
description: Please provide a minimal reproducible Go code example
51+
placeholder: |
52+
```go
53+
package main
54+
55+
type Example struct {
56+
Field1 string
57+
Field2 int
58+
}
59+
60+
func main() {
61+
// Your code here
62+
}
63+
```
64+
render: go
65+
validations:
66+
required: false
67+
68+
- type: textarea
69+
id: configuration
70+
attributes:
71+
label: Configuration
72+
description: Please share your exhaustruct configuration (command flags, .golangci.yml section, etc.)
73+
placeholder: |
74+
Command line flags used:
75+
-i "pattern1" -e "pattern2"
76+
77+
Or golangci-lint configuration:
78+
```yaml
79+
linters-settings:
80+
exhaustruct:
81+
include:
82+
- pattern1
83+
exclude:
84+
- pattern2
85+
```
86+
render: yaml
87+
validations:
88+
required: false
89+
90+
- type: textarea
91+
id: additional-context
92+
attributes:
93+
label: Additional Context
94+
description: Add any other context about the problem here
95+
placeholder: Screenshots, environment details, related issues, etc.
96+
validations:
97+
required: false
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Feature Request
2+
description: Suggest an idea or enhancement for exhaustruct analyzer
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to suggest a new feature! Please provide as much detail as possible to help us understand your request.
11+
12+
- type: textarea
13+
id: problem-summary
14+
attributes:
15+
label: Is your feature request related to a problem?
16+
description: A clear and concise description of what the problem is
17+
placeholder: I'm always frustrated when... / It would be helpful if... / Currently exhaustruct doesn't support...
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: solution
23+
attributes:
24+
label: Describe the solution you'd like
25+
description: A clear and concise description of what you want to happen
26+
placeholder: I would like exhaustruct to...
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: use-case
32+
attributes:
33+
label: Use Case
34+
description: Describe your specific use case and how this feature would help
35+
placeholder: |
36+
In my project, I often need to...
37+
This feature would help by...
38+
Current workaround (if any)...
39+
validations:
40+
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: true
2+
contact_links:
3+
- name: GitHub Discussions
4+
url: https://github.com/GaijinEntertainment/go-exhaustruct/discussions
5+
about: Ask questions and discuss ideas with the community
6+
- name: golangci-lint Documentation
7+
url: https://golangci-lint.run/usage/linters/#exhaustruct
8+
about: Check the official golangci-lint documentation for configuration help

0 commit comments

Comments
 (0)