Skip to content

Commit f207541

Browse files
daniel-kmiecikdaniel-kmiecik
committed
chore: add GitHub issue and pull request templates
1 parent 212d876 commit f207541

File tree

4 files changed

+271
-0
lines changed

4 files changed

+271
-0
lines changed

‎.github/ISSUE_TEMPLATE/01_bug_report.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
name: "Bug Report"
3+
about: Report a reproducible issue with swagger-codegen-generators
4+
title: "[Bug]: "
5+
labels: Bug
6+
assignees: ''
7+
---
8+
9+
## Description
10+
11+
<!--
12+
Clearly describe the problem you're experiencing.
13+
14+
Helpful to include:
15+
- What generator or template is affected?
16+
- What is the incorrect behavior?
17+
- What did you expect instead?
18+
-->
19+
20+
## Version
21+
22+
<!--
23+
Specify the version of swagger-codegen-generators (e.g. v1.0.41).
24+
-->
25+
26+
### Can you identify when the issue first appeared?
27+
28+
<!--
29+
If known, specify the earliest version where the bug occurs.
30+
-->
31+
32+
## Language / Generator Affected
33+
34+
<!--
35+
Examples:
36+
- java
37+
- spring
38+
- typescript-node
39+
- go
40+
-->
41+
42+
## OpenAPI/Swagger Spec
43+
44+
<!--
45+
Include a minimal example spec (inline or via link) that causes the issue.
46+
-->
47+
48+
```yaml
49+
# Example spec snippet or reference URL
50+
```
51+
52+
## Command Line or Configuration Used
53+
54+
<!--
55+
Paste the command or configuration that runs the generator.
56+
-->
57+
58+
```bash
59+
swagger-codegen generate -g java -i example.yaml -o output
60+
```
61+
62+
## Steps to Reproduce
63+
<!-- 1. Use this spec: ... 2. Run this command: ... 3. Observe this incorrect output: ... -->
64+
65+
## Expected Behavior
66+
<!-- Describe what you expected to happen. -->
67+
68+
## Actual Behavior
69+
<!-- Describe what actually happened, and include relevant logs or output differences. -->
70+
71+
## Related Issues / Repos
72+
<!-- If similar bugs exist, mention them. Example: "Looks like #123" or "Also occurs in swagger-codegen" -->
73+
74+
## Environment
75+
76+
OS: <!-- e.g. Ubuntu 22.04, macOS 14, Windows 11 -->
77+
78+
Java Version: <!-- e.g. OpenJDK 17 -->
79+
80+
Build Tool: <!-- CLI / Maven / Gradle -->
81+
82+
swagger-codegen-generators Version: <!-- e.g. v1.0.41 -->
83+
84+
## Additional Context
85+
<!-- Add logs, screenshots, or any other helpful details. -->
86+
87+
## Checklist
88+
89+
- [ ] I have searched the [existing issues](https://github.com/swagger-api/swagger-codegen-generators/issues) to avoid duplicates.
90+
- [ ] I have included a minimal reproducible spec or configuration.
91+
- [ ] I have clearly described the steps to reproduce the issue.
92+
- [ ] I have specified which generator or template is affected.

‎.github/ISSUE_TEMPLATE/02_question.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
name: "Question"
3+
about: Ask a general question or seek clarification about swagger-codegen-generators
4+
title: "[Question]: "
5+
labels: Question
6+
assignees: ''
7+
---
8+
9+
## Your Question
10+
11+
<!--
12+
What do you need help understanding?
13+
14+
Examples:
15+
- How to configure a specific generator option?
16+
- Is feature X supported?
17+
-->
18+
19+
## What Have You Tried?
20+
21+
<!--
22+
Describe any research or debugging you've done.
23+
24+
Examples:
25+
- Links to docs you read
26+
- GitHub issues you checked
27+
- Code examples you explored
28+
-->
29+
30+
## Relevant Generator / Language
31+
32+
<!--
33+
Mention the generator you're working with, if applicable.
34+
35+
Examples:
36+
- java
37+
- spring
38+
- go
39+
- kotlin-server
40+
-->
41+
42+
## OpenAPI/Swagger Spec (Optional)
43+
44+
<!--
45+
If your question is based on a spec or input file, include a small snippet or link here.
46+
-->
47+
48+
```yaml
49+
# Optional: paste relevant part of your spec
50+
```
51+
52+
## Environment
53+
54+
OS: <!-- e.g. Ubuntu 22.04, macOS 14, Windows 11 -->
55+
56+
Java Version: <!-- e.g. OpenJDK 17 -->
57+
58+
swagger-codegen-generators Version: <!-- e.g. v1.0.41 -->
59+
60+
Build Tool: <!-- CLI / Maven / Gradle -->
61+
62+
## Additional Details
63+
<!-- Any extra context, screenshots, or links to related discussions. -->
64+
65+
## Checklist
66+
67+
- [ ] I have searched the [existing issues](https://github.com/swagger-api/swagger-codegen-generators/issues) to avoid duplicates.
68+
- [ ] This is not a bug report or feature request.
69+
- [ ] I have included enough context for someone to answer the question.

‎.github/ISSUE_TEMPLATE/03_feature_request.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
name: "Feature Request"
3+
about: Suggest a new feature or enhancement
4+
title: "[Feature]: "
5+
labels: Feature
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
11+
<!--
12+
Describe the feature you'd like to see added.
13+
14+
Examples:
15+
- New generator (e.g. kotlin-http-client)
16+
- Support for OpenAPI 3.1 feature
17+
- Improve compatibility with build tools
18+
-->
19+
20+
## Use Case
21+
22+
<!--
23+
Why is this feature important?
24+
- What problem does it solve?
25+
- How would it benefit users or improve the project?
26+
-->
27+
28+
## Suggested Solution (optional)
29+
30+
<!--
31+
If you have any implementation ideas or expectations for how it could work, include them here.
32+
You can suggest:
33+
- New CLI options or config values
34+
- Changes to templates or generators
35+
- API enhancements
36+
-->
37+
38+
## Alternatives Considered
39+
40+
<!--
41+
Have you tried any workarounds or third-party tools to achieve the same goal?
42+
-->
43+
44+
## Environment (if relevant)
45+
46+
- OS: <!-- e.g. Ubuntu 22.04, macOS 14, Windows 11 -->
47+
- Java Version: <!-- e.g. OpenJDK 17 -->
48+
- swagger-codegen-generators Version: <!-- e.g. v1.0.41 -->
49+
- Related Generator: <!-- e.g. java, spring, php, go -->
50+
51+
## Additional Context
52+
53+
<!--
54+
Anything else you'd like to add — mockups, diagrams, CLI usage, config files, etc.
55+
-->
56+
57+
## Checklist
58+
59+
- [ ] I have searched the [existing issues](https://github.com/swagger-api/swagger-codegen-generators/issues) to ensure this feature hasn’t been requested yet.
60+
- [ ] This is not a question or bug report.
61+
- [ ] I have described the use case clearly.

‎.github/pull_request_template.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Pull Request
2+
3+
Thank you for contributing to **swagger-codegen-generators**!
4+
5+
Please fill out the following checklist to help us review your PR efficiently.
6+
7+
---
8+
9+
## Description
10+
11+
<!--
12+
Clearly describe what your PR does.
13+
- What feature or fix are you adding?
14+
- Which templates or generators are affected?
15+
- Is it related to a specific issue?
16+
-->
17+
18+
19+
Fixes: <!-- e.g. #123 (optional) -->
20+
21+
## Type of Change
22+
23+
<!-- Check all that apply: -->
24+
25+
- [ ] 🐛 Bug fix
26+
- [ ] ✨ New feature
27+
- [ ] ♻️ Refactor (non-breaking change)
28+
- [ ] 🧪 Tests
29+
- [ ] 📝 Documentation
30+
- [ ] 🧹 Chore (build or tooling)
31+
32+
## Checklist
33+
34+
- [ ] I have added/updated tests as needed
35+
- [ ] I have added/updated documentation where applicable
36+
- [ ] The PR title is descriptive
37+
- [ ] The code builds and passes tests locally
38+
- [ ] I have linked related issues (if any)
39+
40+
## How to Test
41+
42+
<!--
43+
Describe how reviewers can test your changes.
44+
Include sample command lines or configurations if applicable.
45+
-->
46+
47+
## Screenshots / Additional Context
48+
49+
<!-- Optional: Add logs, screenshots, or notes for reviewers -->

0 commit comments

Comments
 (0)