Skip to content

Commit 897d8b1

Browse files
committed
docs(repo): add GitHub issue templates for bugs and feature requests
1 parent ee2472c commit 897d8b1

File tree

3 files changed

+90
-0
lines changed

3 files changed

+90
-0
lines changed
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: "🐞 Bug report"
2+
description: "Report a bug or unexpected behavior in generated clients or schema registration"
3+
title: "bugfix: <short summary>"
4+
labels: ["bug"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for taking the time to improve **spring-boot-openapi-generics-clients**!
11+
Please provide details so we can reproduce and fix the issue quickly.
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: "Describe the bug"
16+
description: "A clear and concise description of what the bug is and how it affects the output."
17+
placeholder: "Example: Generated client omits x-data-item when using nested Page<T> response."
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: reproduction
22+
attributes:
23+
label: "Steps to reproduce"
24+
description: "List the minimal steps to reproduce the issue."
25+
placeholder: |
26+
1. Run `mvn clean install` on customer-service-client
27+
2. Inspect generated model under src/gen/java
28+
3. Observe missing type or mismatch
29+
- type: textarea
30+
id: expected
31+
attributes:
32+
label: "Expected behavior"
33+
description: "What did you expect instead?"
34+
placeholder: "The generator should create ServiceResponsePageCustomerDto extending ServiceClientResponse<Page<CustomerDto>>."
35+
- type: textarea
36+
id: environment
37+
attributes:
38+
label: "Environment"
39+
description: "Tool versions or environment details."
40+
placeholder: |
41+
- Java: 21
42+
- OpenAPI Generator: 7.16.0
43+
- Spring Boot: 3.4.x
44+
- OS: macOS / Windows / Linux
45+
- type: textarea
46+
id: additional
47+
attributes:
48+
label: "Additional context"
49+
description: "Any logs, screenshots, or related discussions."
50+
placeholder: "Link to related discussion or stack trace."

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Start a discussion
4+
url: https://github.com/bsayli/spring-boot-openapi-generics-clients/discussions
5+
about: For questions, design feedback, or sharing ideas
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: "💡 Feature request"
2+
description: "Suggest an enhancement or new capability"
3+
title: "feature: <short summary>"
4+
labels: ["enhancement"]
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for helping evolve **spring-boot-openapi-generics-clients**!
11+
Please share your idea and reasoning below.
12+
- type: textarea
13+
id: problem
14+
attributes:
15+
label: "Is your feature request related to a problem?"
16+
description: "Describe what limitation or gap you're facing."
17+
placeholder: "I'm always frustrated when I have to manually mark generic containers for registration..."
18+
- type: textarea
19+
id: solution
20+
attributes:
21+
label: "Describe the solution you'd like"
22+
description: "Describe the change or new capability you'd like to see."
23+
placeholder: "Automatically detect Page<T> and Slice<T> containers without configuration."
24+
- type: textarea
25+
id: alternatives
26+
attributes:
27+
label: "Describe alternatives you've considered"
28+
description: "Mention any workarounds or similar ideas."
29+
placeholder: "I've tried extending AutoWrapperSchemaCustomizer manually, but it’s verbose."
30+
- type: textarea
31+
id: additional
32+
attributes:
33+
label: "Additional context"
34+
description: "Include screenshots, examples, or references."
35+
placeholder: "Maybe integrate with Springdoc plugin system like openapi-kotlinx."

0 commit comments

Comments
 (0)