Skip to content

Commit fc5508c

Browse files
authored
Update issue templates
1 parent 35ceaf7 commit fc5508c

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
- If you are reporting a bug, please help to speed up problem diagnosis by providing as much information as possible:
12+
- A clear and concise description of what the bug is: the title of an issue is not enough
13+
14+
**To Reproduce**
15+
Steps to reproduce the behavior:
16+
- What version of spring-boot you are using?
17+
- What modules and versions of springdoc-openapi are you using?
18+
- What is the actual and the expected result using OpenAPI Description (yml or json)?
19+
- Provide with a sample code (HelloController) or Test that reproduces the problem
20+
21+
**Expected behavior**
22+
- A clear and concise description of what you expected to happen.
23+
- What is the expected result using OpenAPI Description (yml or json)?
24+
25+
**Screenshots**
26+
If applicable, add screenshots to help explain your problem.
27+
28+
**Additional context**
29+
Add any other context about the problem here.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
- What is the actual result using OpenAPI Description (yml or json)?
13+
14+
**Describe the solution you'd like**
15+
- A clear and concise description of what you want to happen.
16+
- What is the expected result using OpenAPI Description (yml or json)?
17+
18+
**Describe alternatives you've considered**
19+
- A clear and concise description of any alternative solutions or features you've considered.
20+
21+
**Additional context**
22+
- Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)