Update issue template
Lifted from the wonderful Babel issue template: https://github.com/babel/babel/issues/new
This commit is contained in:
64
.github/issue_template.md
vendored
64
.github/issue_template.md
vendored
@@ -1,3 +1,61 @@
|
|||||||
When reporting an issue, please provide the following details:
|
<!---
|
||||||
- swagger-ui version
|
Thanks for filing an issue 😄 ! Before you submit, please read the following:
|
||||||
- a swagger file reproducing the issue
|
|
||||||
|
Search open/closed issues before submitting since someone might have asked the same thing before!
|
||||||
|
|
||||||
|
Issues on GitHub are only related to problems of Swagger-UI itself. We'll try to offer support
|
||||||
|
here for you use case, but we can't offer help with projects that use Swagger-UI indirectly,
|
||||||
|
like Springfox or swagger-node.
|
||||||
|
|
||||||
|
Likewise, we can't accept features or bugs in the Swagger/OpenAPI specifications themselves,
|
||||||
|
or anything that violates the specifications.
|
||||||
|
|
||||||
|
-->
|
||||||
|
|
||||||
|
<!--- Provide a general summary of the issue in the title above -->
|
||||||
|
|
||||||
|
|
||||||
|
| Q | A
|
||||||
|
| ------------------------------- | -------
|
||||||
|
| Bug or feature request? |
|
||||||
|
| Which Swagger/OpenAPI version? |
|
||||||
|
| Which Swagger-UI version? |
|
||||||
|
| How did you install Swagger-UI? |
|
||||||
|
| Which broswer & version? |
|
||||||
|
| Which operating system? |
|
||||||
|
|
||||||
|
|
||||||
|
### Demonstration spec
|
||||||
|
<!--- If you're describing a bug, please provide a spec that reproduces your problem -->
|
||||||
|
<!--- If you have link to a demo repo please link that! -->
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
your: "spec goes here"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Configuration (browser query string, constructor, config.yaml)
|
||||||
|
<!--- If describing a bug, tell us what your configuration looks like -->
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
"your": { "constructorConfig": "here" }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
`?yourQueryStringConfig=here`
|
||||||
|
|
||||||
|
### Expected Behavior
|
||||||
|
<!--- If you're describing a bug, tell us what should happen -->
|
||||||
|
<!--- If you're suggesting a change/improvement, tell us how it should work -->
|
||||||
|
|
||||||
|
### Current Behavior
|
||||||
|
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
|
||||||
|
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
|
||||||
|
|
||||||
|
### Possible Solution
|
||||||
|
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
|
||||||
|
<!--- or ideas how to implement the addition or change -->
|
||||||
|
|
||||||
|
### Context
|
||||||
|
<!--- How has this issue affected you? What are you trying to accomplish? -->
|
||||||
|
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
|
||||||
|
|||||||
Reference in New Issue
Block a user