Skip to content

Commit a37d637

Browse files
authored
meta: multiple issue templates (#4519)
* MOAR issue templates * ...LESS issue templates
1 parent 7574742 commit a37d637

File tree

4 files changed

+168
-70
lines changed

4 files changed

+168
-70
lines changed
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
name: Bug report
3+
about: Report an issue you're experiencing
4+
5+
---
6+
7+
<!---
8+
Thanks for filing a bug report 😄 ! Before you submit, please read the following:
9+
10+
If you're here to report a security issue, please STOP writing an issue and
11+
contact us at [email protected] instead!
12+
13+
Search open/closed issues before submitting!
14+
15+
Issues on GitHub are only related to problems of Swagger-UI itself. We'll try
16+
to offer support here for your use case, but we can't offer help with projects
17+
that use Swagger-UI indirectly, like Springfox or swagger-node.
18+
19+
Likewise, we can't accept bugs in the Swagger/OpenAPIspecifications themselves,
20+
or anything that violates the specifications.
21+
22+
-->
23+
24+
## Q&A (please complete the following information)
25+
- OS: [e.g. macOS]
26+
- Browser: [e.g. chrome, safari]
27+
- Version: [e.g. 22]
28+
- Method of installation: [e.g. npm, dist assets]
29+
- Swagger-UI version: [e.g. 3.10.0]
30+
- Swagger/OpenAPI version: [e.g. Swagger 2.0, OpenAPI 3.0]
31+
32+
### Content & configuration
33+
<!--
34+
Provide us with a way to see what you're seeing,
35+
so that we can fix your issue.
36+
-->
37+
38+
Example Swagger/OpenAPI definition:
39+
```yaml
40+
# your YAML here
41+
```
42+
43+
Swagger-UI configuration options:
44+
```js
45+
SwaggerUI({
46+
// your config options here
47+
})
48+
```
49+
50+
```
51+
?yourQueryStringConfig
52+
```
53+
54+
### Describe the bug you're encountering
55+
<!-- A clear and concise description of what the bug is. -->
56+
57+
### To reproduce...
58+
59+
Steps to reproduce the behavior:
60+
1. Go to '...'
61+
2. Click on '....'
62+
3. Scroll down to '....'
63+
4. See error
64+
65+
### Expected behavior
66+
<!-- A clear and concise description of what you expected to happen. -->
67+
68+
### Screenshots
69+
<!-- If applicable, add screenshots to help explain your problem. -->
70+
71+
### Additional context or thoughts
72+
<!-- Add any other context about the problem here. -->
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 an new feature or enhancement for this project
4+
5+
---
6+
7+
## Q&A (please complete the following information)
8+
- OS: [e.g. macOS]
9+
- Browser: [e.g. chrome, safari]
10+
- Version: [e.g. 22]
11+
- Method of installation: [e.g. npm, dist assets]
12+
- Swagger-UI version: [e.g. 3.10.0]
13+
- Swagger/OpenAPI version: [e.g. Swagger 2.0, OpenAPI 3.0]
14+
15+
### Content & configuration
16+
17+
Swagger/OpenAPI definition:
18+
```yaml
19+
# your YAML here
20+
```
21+
22+
Swagger-UI configuration options:
23+
```js
24+
SwaggerUI({
25+
// your config options here
26+
})
27+
```
28+
29+
```
30+
?yourQueryStringConfig
31+
```
32+
33+
34+
### Is your feature request related to a problem?
35+
<!--
36+
Please provide a clear and concise description of what the problem is.
37+
"I'm always frustrated when..."
38+
-->
39+
40+
### Describe the solution you'd like
41+
<!-- A clear and concise description of what you want to happen. -->
42+
43+
### Describe alternatives you've considered
44+
<!--
45+
A clear and concise description of any alternative solutions or features
46+
you've considered.
47+
-->
48+
49+
### Additional context
50+
<!-- Add any other context or screenshots about the feature request here. -->

.github/ISSUE_TEMPLATE/Support.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Support
3+
about: Ask a question or request help with your implementation.
4+
5+
---
6+
7+
<!--
8+
We can only offer support for Swagger-UI itself.
9+
10+
If you're having a problem with a library that uses Swagger-UI
11+
(for example, Springfox or swagger-node), please open an issue
12+
in that project's repository instead.
13+
-->
14+
15+
### Q&A (please complete the following information)
16+
- OS: [e.g. macOS]
17+
- Browser: [e.g. chrome, safari]
18+
- Version: [e.g. 22]
19+
- Method of installation: [e.g. npm, dist assets]
20+
- Swagger-UI version: [e.g. 3.10.0]
21+
- Swagger/OpenAPI version: [e.g. Swagger 2.0, OpenAPI 3.0]
22+
23+
### Content & configuration
24+
<!-- Provide us with a way to see what you're seeing, so that we can help. -->
25+
26+
Swagger/OpenAPI definition:
27+
```yaml
28+
# your YAML here
29+
```
30+
31+
Swagger-UI configuration options:
32+
```js
33+
SwaggerUI({
34+
// your config options here
35+
})
36+
```
37+
38+
```
39+
?yourQueryStringConfig
40+
```
41+
42+
### Screenshots
43+
<!-- If applicable, add screenshots to help give context to your problem. -->
44+
45+
### How can we help?
46+
<!-- Your question or problem goes here! -->

.github/issue_template.md

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

0 commit comments

Comments
 (0)