Skip to content

Commit fa5279d

Browse files
daniel-kmiecikdaniel-kmiecik
committed
chore: add GitHub issue and pull request templates
1 parent c8f0069 commit fa5279d

File tree

4 files changed

+196
-0
lines changed

4 files changed

+196
-0
lines changed

‎.github/ISSUE_TEMPLATE/01_bug_report.md‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
name: "Bug Report"
3+
about: Report a reproducible issue in swagger-parser
4+
title: "[Bug]: "
5+
labels: Bug
6+
assignees: ''
7+
---
8+
9+
## Description
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 parse?
15+
- Which format or version of the spec is affected (OpenAPI 3.0/3.1, Swagger 2.0)?
16+
- Is the parser returning null, throwing, or giving unexpected results?
17+
-->
18+
19+
## Affected Version
20+
21+
<!-- What version of swagger-parser are you using? -->
22+
e.g. 2.1.15
23+
24+
<!-- Can you identify when the issue was introduced?
25+
If yes, please provide the earliest version you know the bug exists in. -->
26+
Earliest version the bug appears in (if known):
27+
e.g. 2.1.10
28+
29+
## Steps to Reproduce
30+
31+
<!-- Provide a step-by-step list on how to reproduce the issue.
32+
Include example OpenAPI/Swagger definitions if possible. -->
33+
34+
1. ...
35+
2. ...
36+
3. ...
37+
38+
## Expected Behavior
39+
40+
<!-- What should have happened? -->
41+
42+
## Actual Behavior
43+
44+
<!-- What actually happened instead? -->
45+
46+
## Logs / Stack Traces
47+
48+
<!-- Paste relevant log output or error messages, if any. -->
49+
50+
## Environment
51+
52+
<!-- Provide details about your environment. -->
53+
54+
- Java version: <!-- e.g. OpenJDK 17 -->
55+
- Build tool: <!-- e.g. Maven 3.9, Gradle 8.1 -->
56+
- OS: <!-- e.g. Ubuntu 22.04, Windows 11 -->
57+
58+
## Additional Context
59+
60+
<!-- Add any other context, links, or example spec files here. -->
61+
62+
## Checklist
63+
64+
- [ ] I have searched the [existing issues](https://github.com/swagger-api/swagger-parser/issues) and this is not a duplicate.
65+
- [ ] I have provided sufficient information for maintainers to reproduce the issue.

‎.github/ISSUE_TEMPLATE/02_question.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: "Question"
3+
about: Ask a question about swagger-parser usage or behavior
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 are you trying to parse or validate?
16+
- What OpenAPI or Swagger version is involved?
17+
- Are you using the parser standalone or integrated with another tool?
18+
- What have you tried so far?
19+
-->
20+
21+
## Affected Version
22+
23+
<!-- What version of swagger-parser are you using? -->
24+
e.g. 2.1.15
25+
26+
## Context
27+
28+
<!--
29+
Include any relevant code snippets, spec definitions, or errors you're seeing.
30+
This helps others understand the situation quickly.
31+
-->
32+
33+
```yaml
34+
# Example OpenAPI or Swagger definition (optional)
35+
```
36+
37+
## Additional Details
38+
39+
<!-- Any other information that could help clarify your question. -->
40+
41+
## Checklist
42+
43+
- [ ] I have searched the [existing issues](https://github.com/swagger-api/swagger-parser/issues) and documentation before asking.
44+
- [ ] I have provided enough information for others to understand my question.

‎.github/ISSUE_TEMPLATE/03_feature_request.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: "Feature Request"
3+
about: Suggest a new feature or enhancement for swagger-parser
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+
14+
Consider:
15+
- What problem does it solve?
16+
- Is it about OpenAPI version support, validation improvements, external references, etc.?
17+
-->
18+
19+
## Use Case
20+
21+
<!--
22+
Explain how this feature would be useful in real-world scenarios.
23+
E.g. parsing complex OpenAPI 3.1 specs, supporting $dynamicRef, extending validation logic, etc.
24+
-->
25+
26+
## Suggested Solution (optional)
27+
28+
<!--
29+
If you have any implementation ideas or expectations for how it could work, include them here.
30+
-->
31+
32+
## Alternatives Considered
33+
34+
<!--
35+
Have you tried any workarounds or third-party tools to achieve the same goal?
36+
-->
37+
38+
## Additional Context
39+
40+
<!-- Add any relevant links, specifications, use cases, etc. -->
41+
42+
## Checklist
43+
44+
- [ ] I have searched the [existing issues](https://github.com/swagger-api/swagger-parser/issues) to ensure this is not a duplicate.
45+
- [ ] This feature would be useful to more than just my use case.
46+
- [ ] I have provided enough detail for the maintainers to understand the scope of the request.

‎.github/pull_request_template.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Pull Request
2+
3+
Thank you for contributing to **swagger-parser**!
4+
5+
Please fill out the following checklist 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+
- [ ] I have added/updated tests as needed
34+
- [ ] I have added/updated documentation where applicable
35+
- [ ] The PR title is descriptive
36+
- [ ] The code builds and passes tests locally
37+
- [ ] I have linked related issues (if any)
38+
39+
## Screenshots / Additional Context
40+
41+
<!-- Optional: Add logs, screenshots, or notes for reviewers -->

0 commit comments

Comments
 (0)