Skip to content

chore: add GitHub issue and pull request templates #2212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions .github/ISSUE_TEMPLATE/01_bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
name: "Bug Report"
about: Report a reproducible issue in swagger-parser
title: "[Bug]: "
labels: Bug
assignees: ''
---

## Description

<!--
Provide a clear and concise description of the problem.
To help us understand the issue better, consider including:
- What are you trying to parse?
- Which format or version of the spec is affected (OpenAPI 3.0/3.1, Swagger 2.0)?
- Is the parser returning null, throwing, or giving unexpected results?
-->

## Affected Version

<!-- What version of swagger-parser are you using? -->
e.g. 2.1.15

<!-- Can you identify when the issue was introduced?
If yes, please provide the earliest version you know the bug exists in. -->
Earliest version the bug appears in (if known):
e.g. 2.1.10

## Steps to Reproduce

<!-- Provide a step-by-step list on how to reproduce the issue.
Include example OpenAPI/Swagger definitions if possible. -->

1. ...
2. ...
3. ...

## Expected Behavior

<!-- What should have happened? -->

## Actual Behavior

<!-- What actually happened instead? -->

## Logs / Stack Traces

<!-- Paste relevant log output or error messages, if any. -->

## Environment

<!-- Provide details about your environment. -->

- Java version: <!-- e.g. OpenJDK 17 -->
- Build tool: <!-- e.g. Maven 3.9, Gradle 8.1 -->
- OS: <!-- e.g. Ubuntu 22.04, Windows 11 -->

## Additional Context

<!-- Add any other context, links, or example spec files here. -->

## Checklist

- [ ] I have searched the [existing issues](https://github.com/swagger-api/swagger-parser/issues) and this is not a duplicate.
- [ ] I have provided sufficient information for maintainers to reproduce the issue.
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/02_question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
name: "Question"
about: Ask a question about swagger-parser usage or behavior
title: "[Question]: "
labels: Question
assignees: ''
---

## Question

<!--
Clearly describe your question or what you're trying to understand.

To help us help you, consider including:
- What are you trying to parse or validate?
- What OpenAPI or Swagger version is involved?
- Are you using the parser standalone or integrated with another tool?
- What have you tried so far?
-->

## Affected Version

<!-- What version of swagger-parser are you using? -->
e.g. 2.1.15

## Context

<!--
Include any relevant code snippets, spec definitions, or errors you're seeing.
This helps others understand the situation quickly.
-->

```yaml
# Example OpenAPI or Swagger definition (optional)
```

## Additional Details

<!-- Any other information that could help clarify your question. -->

## Checklist

- [ ] I have searched the [existing issues](https://github.com/swagger-api/swagger-parser/issues) and documentation before asking.
- [ ] I have provided enough information for others to understand my question.
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/03_feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: "Feature Request"
about: Suggest a new feature or enhancement for swagger-parser
title: "[Feature]: "
labels: Feature
assignees: ''
---

## Feature Description

<!--
Describe the feature you'd like to see.

Consider:
- What problem does it solve?
- Is it about OpenAPI version support, validation improvements, external references, etc.?
-->

## Use Case

<!--
Explain how this feature would be useful in real-world scenarios.
E.g. parsing complex OpenAPI 3.1 specs, supporting $dynamicRef, extending validation logic, etc.
-->

## Suggested Solution (optional)

<!--
If you have any implementation ideas or expectations for how it could work, include them here.
-->

## Alternatives Considered

<!--
Have you tried any workarounds or third-party tools to achieve the same goal?
-->

## Additional Context

<!-- Add any relevant links, specifications, use cases, etc. -->

## Checklist

- [ ] I have searched the [existing issues](https://github.com/swagger-api/swagger-parser/issues) to ensure this is not a duplicate.
- [ ] This feature would be useful to more than just my use case.
- [ ] I have provided enough detail for the maintainers to understand the scope of the request.
41 changes: 41 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Pull Request

Thank you for contributing to **swagger-parser**!

Please fill out the following checklist to help us review your PR efficiently.

---

## Description

<!--
Describe what this PR changes:
- What problem does it solve?
- Is it a bug fix, new feature, or refactor?
- Link to any related issues.
-->

Fixes: <!-- e.g. #123 (optional) -->

## Type of Change

<!-- Check all that apply: -->

- [ ] 🐛 Bug fix
- [ ] ✨ New feature
- [ ] ♻️ Refactor (non-breaking change)
- [ ] 🧪 Tests
- [ ] 📝 Documentation
- [ ] 🧹 Chore (build or tooling)

## Checklist

- [ ] I have added/updated tests as needed
- [ ] I have added/updated documentation where applicable
- [ ] The PR title is descriptive
- [ ] The code builds and passes tests locally
- [ ] I have linked related issues (if any)

## Screenshots / Additional Context

<!-- Optional: Add logs, screenshots, or notes for reviewers -->
Loading