Skip to content

Commit b1dec90

Browse files
authored
Simplify issue templates
1 parent c92f001 commit b1dec90

File tree

3 files changed

+21
-64
lines changed

3 files changed

+21
-64
lines changed
Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,29 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: Report a reproducible bug
44
title: ''
55
labels: bug
66
assignees: ''
7-
---
87

9-
<!--- If you can, please recreate the bug in a quick test:
8+
---
109

11-
Simply clone master and use our bug recreation template for chai-openapi-response-validator (https://github.com/openapi-library/OpenAPIValidators/blob/master/packages/chai-openapi-response-validator/test/bugRecreationTemplate.test.ts)
10+
**Are you using jest or chai**?
1211

13-
or jest-openapi (https://github.com/openapi-library/OpenAPIValidators/blob/master/packages/jest-openapi/__test__/bugRecreationTemplate.test.ts)
14-
-->
1512

16-
**Which package are you using**?
17-
`chai-openapi-response-validator` / `jest-openapi`
13+
**Are you using OpenAPI 2, 3.0.X, or 3.1.0?**
1814

19-
**OpenAPI version**
20-
2 and/or 3?
2115

22-
**Describe the bug**
23-
A clear and concise description of what the bug is.
16+
**Describe the bug clearly**
2417

25-
**To Reproduce**
26-
Steps to reproduce the behavior:
2718

28-
1. Do ...
29-
2. Do ...
30-
3. See error
19+
**Steps to reproduce the bug:**
20+
1. ...
21+
2. ...
22+
3. See error (please paste error output or a screenshot)
3123

32-
**Expected behavior**
33-
A clear and concise description of what you expected to happen.
24+
<!--- Ideally, recreate the bug on a branch using our template for jest ((https://github.com/openapi-library/OpenAPIValidators/blob/master/packages/jest-openapi/__test__/bugRecreationTemplate.test.ts)) or chai (https://github.com/openapi-library/OpenAPIValidators/blob/master/packages/chai-openapi-response-validator/test/bugRecreationTemplate.test.ts) -->
3425

35-
**Screenshots**
36-
If applicable, add screenshots to help explain your problem.
26+
**What did you expect to happen instead?**
3727

38-
**Additional context**
39-
Add any other context about the problem here.
4028

4129
**Are you going to resolve the issue?**
42-
43-
<!--- Feel free to ask for any help and read our [PR guide](https://github.com/openapi-library/OpenAPIValidators/blob/master/CONTRIBUTING.md#pull-requests) -->

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,22 @@ about: Suggest an idea for this project
44
title: ''
55
labels: enhancement
66
assignees: ''
7+
78
---
89

9-
**OpenAPI version**
10-
2 and/or 3?
10+
**Are you using OpenAPI 2, 3.0.X, or 3.1.0?**
11+
12+
13+
**Would this solve a problem or make something easier?**
14+
1115

12-
**Is your feature request related to a problem? Please describe.**
13-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
16+
**What would you like to happen?**
1417

15-
**Describe the solution you'd like**
16-
A clear and concise description of what you want to happen.
1718

1819
**Describe alternatives you've considered**
19-
A clear and concise description of any alternative solutions or features you've considered.
2020

21-
**Additional context**
22-
Add any other context or screenshots about the feature request here.
2321

24-
**Are you going to resolve the issue?**
22+
**Additional context or screenshots**
23+
2524

26-
<!--- Feel free to ask for any help and read our [PR guide](https://github.com/openapi-library/OpenAPIValidators/blob/master/CONTRIBUTING.md#pull-requests) -->
25+
**Are you going to resolve the issue?**

.github/ISSUE_TEMPLATE/other-dev-issue.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)