Skip to content

Commit b16924c

Browse files
daniel-kmiecikdaniel-kmiecik
committed
chore: add GitHub issue and pull request templates
1 parent 045c8a3 commit b16924c

File tree

4 files changed

+195
-0
lines changed

4 files changed

+195
-0
lines changed

‎.github/ISSUE_TEMPLATE/01_bug_report.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
name: Bug Report
3+
about: Report an issue in swagger-core
4+
title: "[Bug]: "
5+
labels: Bug
6+
assignees: ''
7+
---
8+
9+
## Description of the problem/issue
10+
11+
<!--
12+
Provide a clear and concise description of the problem.
13+
To help us understand the issue better, consider including:
14+
- What are you trying to achieve using swagger-core?
15+
- Are specific annotations not behaving as expected? (e.g., @Schema, @Parameter, @Operation)
16+
- Are generated OpenAPI specs missing information or incorrect?
17+
- Are you using swagger-core with JAX-RS, Spring, or another framework?
18+
- Did this issue affect code generation (e.g., Swagger Codegen/OpenAPI Generator)?
19+
-->
20+
21+
## Affected Version
22+
23+
<!-- What version of swagger-core are you using? -->
24+
e.g. 2.2.21
25+
26+
<!-- Can you identify when the issue was introduced?
27+
If yes, please provide the earliest version you know the bug exists in. -->
28+
Earliest version the bug appears in (if known):
29+
e.g. 2.2.17
30+
31+
## Steps to Reproduce
32+
33+
<!-- Provide a step-by-step list on how to reproduce the issue.
34+
Include any relevant OpenAPI definitions, configuration, or code snippets. -->
35+
36+
1. ...
37+
2. ...
38+
3. ...
39+
40+
## Expected Behavior
41+
42+
<!-- What should have happened? -->
43+
44+
## Actual Behavior
45+
46+
<!-- What actually happened instead? -->
47+
48+
## Logs / Stack Traces
49+
50+
<!-- Paste relevant log output or error messages, if any. -->
51+
52+
## Additional Context
53+
54+
<!-- Add any other context, links, or screenshots about the problem here. -->
55+
56+
## Checklist
57+
58+
- [ ] I have searched the [existing issues](https://github.com/swagger-api/swagger-core/issues) and this is not a duplicate.
59+
- [ ] I have provided sufficient information for maintainers to reproduce the issue.

‎.github/ISSUE_TEMPLATE/02_question.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Question
3+
about: Ask a question about swagger-core usage or behavior
4+
title: "[Question]: "
5+
labels: Question
6+
assignees: ''
7+
---
8+
9+
## Question
10+
11+
<!--
12+
Please clearly describe your question or the problem you're trying to solve.
13+
To help us answer faster, consider including:
14+
- What are you trying to achieve with swagger-core?
15+
- Which version are you using?
16+
- What have you tried so far?
17+
- Are you encountering unexpected behavior or error messages?
18+
-->
19+
20+
## Affected Version
21+
22+
<!-- What version of swagger-core are you using? -->
23+
e.g. 2.2.21
24+
25+
## Context
26+
27+
<!--
28+
Provide any relevant code snippets, configuration, OpenAPI definitions,
29+
or links to documentation you are referring to.
30+
-->
31+
32+
```java
33+
// Example code snippet here
34+
```
35+
36+
## Additional Details
37+
38+
<!-- Add any other information that might help us understand your question. -->
39+
40+
## Checklist
41+
42+
- [ ] I have searched the [existing issues](https://github.com/swagger-api/swagger-core/issues) and documentation before asking.
43+
- [ ] I have provided enough information for others to understand my question.

‎.github/ISSUE_TEMPLATE/03_feature_request.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement for swagger-core
4+
title: "[Feature]: "
5+
labels: Feature
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
11+
<!--
12+
Describe the feature you'd like to see.
13+
- What problem does it solve?
14+
- How would it improve swagger-core?
15+
- Is it related to OpenAPI spec support, annotation improvements, integration, etc.?
16+
-->
17+
18+
## Use Case
19+
20+
<!--
21+
Explain how you (or others) would use this feature in a real-world project.
22+
Include context to help understand why this is valuable.
23+
-->
24+
25+
## Suggested Solution (optional)
26+
27+
<!--
28+
If you have an idea for how the feature could be implemented, share it here.
29+
This could include proposed APIs, annotations, or behavior.
30+
-->
31+
32+
## Alternatives Considered
33+
34+
<!--
35+
Have you tried other ways to solve this problem?
36+
Are there any existing workarounds?
37+
-->
38+
39+
## Additional Context
40+
41+
<!--
42+
Include any other information, references, or related issues.
43+
Screenshots, links to OpenAPI specs, or code snippets can help too.
44+
-->
45+
46+
## Checklist
47+
48+
- [ ] I have searched the [existing issues](https://github.com/swagger-api/swagger-core/issues) to ensure this is not a duplicate.
49+
- [ ] This feature would be useful to more than just my use case.
50+
- [ ] I have provided enough detail for the maintainers to understand the scope of the request.

‎.github/pull_request_template.md

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

0 commit comments

Comments
 (0)