Skip to content

Commit 506d256

Browse files
daniel-kmiecikdaniel-kmiecik
committed
chore: add GitHub issue and pull request templates
1 parent 151d326 commit 506d256

File tree

4 files changed

+244
-46
lines changed

4 files changed

+244
-46
lines changed

‎.github/ISSUE_TEMPLATE.md

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

‎.github/ISSUE_TEMPLATE/01_bug_report.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
name: "Bug Report"
3+
about: Report a reproducible issue with swagger-codegen
4+
title: "[Bug]: "
5+
labels: Bug
6+
assignees: ''
7+
---
8+
9+
## Description
10+
11+
<!--
12+
Clearly describe the problem you're experiencing.
13+
14+
Consider including:
15+
- What client/server/language are you generating?
16+
- What is the unexpected behavior?
17+
- What should have happened instead?
18+
-->
19+
20+
## Swagger Codegen Version
21+
22+
<!-- e.g. 3.0.45 -->
23+
24+
## Language / Generator
25+
26+
<!--
27+
Specify which generator you're using.
28+
Examples:
29+
- java
30+
- python
31+
- spring
32+
- typescript-angular
33+
- csharp-netcore
34+
-->
35+
36+
## OpenAPI/Swagger Spec
37+
38+
<!--
39+
Include a minimal example of the spec that reproduces the issue.
40+
Paste it inline (in triple backticks), or upload it as a gist.
41+
-->
42+
43+
```yaml
44+
# example snippet or URL to full spec
45+
```
46+
## Command Line Used
47+
48+
<!--
49+
Paste the full CLI command (or Maven/Gradle config) used to run codegen.
50+
-->
51+
52+
```bash
53+
swagger-codegen generate -i petstore.yaml -l java -o output-folder
54+
```
55+
56+
## Steps to Reproduce
57+
58+
<!--
59+
Provide a clear, step-by-step list.
60+
61+
1. ...
62+
2. ...
63+
3. ...
64+
-->
65+
66+
## Expected Behavior
67+
68+
<!--
69+
Describe what should have happened.
70+
-->
71+
72+
## Actual Behavior
73+
74+
<!--
75+
What actually happened? Include any errors, warnings, or incorrect output.
76+
-->
77+
78+
## Related Issues / Repos
79+
80+
<!--
81+
If this issue seems related to an existing one, mention it here.
82+
e.g. "Seems similar to #1234"
83+
-->
84+
85+
## Environment
86+
87+
- OS: <!-- e.g. Ubuntu 22.04, macOS 14, Windows 11 -->
88+
- Java Version: <!-- e.g. OpenJDK 17 -->
89+
- Build Tool: <!-- e.g. CLI, Maven, Gradle -->
90+
- Swagger Codegen CLI version:
91+
92+
## Additional Context
93+
94+
<!--
95+
Include any links, files, screenshots, or notes that help clarify the problem.
96+
-->
97+
98+
## Checklist
99+
100+
- [ ] I have searched the [existing issues](https://github.com/swagger-api/swagger-codegen/issues) to make sure this is not a duplicate.
101+
- [ ] I have included a minimal and reproducible spec example.
102+
- [ ] I have explained how to reproduce the issue.
103+
- [ ] I have specified which generator/language is affected.

‎.github/ISSUE_TEMPLATE/02_question.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
name: "Question"
3+
about: Ask a question about using swagger-codegen
4+
title: "[Question]: "
5+
labels: Question
6+
assignees: ''
7+
---
8+
9+
## Question
10+
11+
<!--
12+
Clearly describe your question or what you're trying to understand.
13+
14+
To help us help you, consider including:
15+
- What generator/language are you using?
16+
- What are you trying to achieve?
17+
- Are you unsure about a CLI flag, config option, or spec feature?
18+
-->
19+
20+
## Swagger Codegen Version
21+
22+
<!-- e.g. 3.0.45 -->
23+
24+
## Language / Generator
25+
26+
<!--
27+
Specify the codegen target language or library.
28+
Examples:
29+
- java
30+
- spring
31+
- python
32+
- typescript-axios
33+
-->
34+
35+
## OpenAPI/Swagger Spec
36+
37+
<!--
38+
Optionally include a snippet of your spec, or describe its structure if relevant.
39+
-->
40+
41+
## Command or Configuration Used
42+
43+
<!--
44+
Paste the relevant CLI command or Maven/Gradle plugin configuration.
45+
-->
46+
47+
```bash
48+
swagger-codegen generate -i your-spec.yaml -l typescript-axios -o output/
49+
```
50+
51+
## What Have You Tried?
52+
53+
<!--
54+
Describe any steps you’ve already taken to solve the issue or investigate the behavior.
55+
Examples:
56+
- I searched the documentation and examples
57+
- I looked through similar GitHub issues
58+
- I tried different config options or generators
59+
-->
60+
61+
## Additional Details
62+
63+
<!--
64+
Any extra context that might help:
65+
- links to documentation you consulted
66+
- screenshots
67+
- output logs or CLI behavior
68+
- clarification about the spec you're using
69+
-->
70+
71+
## Checklist
72+
73+
- [ ] I have searched the [existing issues](https://github.com/swagger-api/swagger-codegen/issues) and documentation.
74+
- [ ] I have provided enough context for maintainers to understand the question.
75+
- [ ] This is not a feature request or bug report.

‎.github/ISSUE_TEMPLATE/03_feature_request.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
name: "Feature Request"
3+
about: Suggest an enhancement or new functionality for swagger-codegen
4+
title: "[Feature]: "
5+
labels: Feature
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
11+
<!--
12+
Briefly describe the feature you'd like to see.
13+
14+
Consider:
15+
- What problem does it solve?
16+
17+
Examples:
18+
- Support for a new language or framework
19+
- Improvements to existing generator output
20+
- Additional CLI options or config settings
21+
22+
-->
23+
24+
## Use Case
25+
26+
<!--
27+
Explain how this feature would be useful in real-world scenarios.
28+
Why is this feature important to you or your project?
29+
30+
Try to answer:
31+
- What problem would this solve?
32+
- Is it blocking something you're trying to do?
33+
- How common is the use case?
34+
-->
35+
36+
## Suggested Solution (optional)
37+
38+
<!--
39+
Describe how you'd like to see this implemented.
40+
41+
If applicable, include:
42+
- Example config options
43+
- Spec snippets
44+
- Expected output/code structure
45+
-->
46+
47+
## Alternatives Considered
48+
49+
<!--
50+
If you've tried workarounds or evaluated other solutions, describe them here.
51+
-->
52+
53+
## Additional Context
54+
55+
<!--
56+
Include any relevant information:
57+
- Related issues or discussions
58+
- Links to similar implementations
59+
- Screenshots or diagrams
60+
-->
61+
62+
## Checklist
63+
64+
- [ ] I have searched the [existing issues](https://github.com/swagger-api/swagger-codegen/issues) to make sure this feature hasn’t been requested already.
65+
- [ ] This feature would be useful to more than just my use case.
66+
- [ ] I have provided enough technical context to understand the request.

0 commit comments

Comments
 (0)