Skip to content

Commit 5346655

Browse files
authored
Merge pull request #3549 from swagger-api/updated-issue-template
Update issue template
2 parents be293de + c35a904 commit 5346655

File tree

1 file changed

+61
-3
lines changed

1 file changed

+61
-3
lines changed

.github/issue_template.md

Lines changed: 61 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,61 @@
1-
When reporting an issue, please provide the following details:
2-
- swagger-ui version
3-
- a swagger file reproducing the issue
1+
<!---
2+
Thanks for filing an issue 😄 ! Before you submit, please read the following:
3+
4+
Search open/closed issues before submitting since someone might have asked the same thing before!
5+
6+
Issues on GitHub are only related to problems of Swagger-UI itself. We'll try to offer support
7+
here for your use case, but we can't offer help with projects that use Swagger-UI indirectly,
8+
like Springfox or swagger-node.
9+
10+
Likewise, we can't accept features or bugs in the Swagger/OpenAPI specifications themselves,
11+
or anything that violates the specifications.
12+
13+
-->
14+
15+
<!--- Provide a general summary of the issue in the title above -->
16+
17+
18+
| Q | A
19+
| ------------------------------- | -------
20+
| Bug or feature request? |
21+
| Which Swagger/OpenAPI version? |
22+
| Which Swagger-UI version? |
23+
| How did you install Swagger-UI? |
24+
| Which broswer & version? |
25+
| Which operating system? |
26+
27+
28+
### Demonstration API definition
29+
<!--- If you're describing a bug, please provide an API definition that reproduces your problem -->
30+
<!--- If you have link to a demo repo please link that! -->
31+
32+
```yaml
33+
your: "API definition goes here"
34+
```
35+
36+
### Configuration (browser query string, constructor, config.yaml)
37+
<!--- If describing a bug, tell us what your configuration looks like -->
38+
39+
```js
40+
{
41+
"your": { "constructorConfig": "here" }
42+
}
43+
```
44+
45+
`?yourQueryStringConfig=here`
46+
47+
### Expected Behavior
48+
<!--- If you're describing a bug, tell us what should happen -->
49+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
50+
51+
### Current Behavior
52+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
53+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
54+
55+
### Possible Solution
56+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
57+
<!--- or ideas how to implement the addition or change -->
58+
59+
### Context
60+
<!--- How has this issue affected you? What are you trying to accomplish? -->
61+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->

0 commit comments

Comments
 (0)