meta: multiple issue templates (#4519)
* MOAR issue templates * ...LESS issue templates
This commit is contained in:
72
.github/ISSUE_TEMPLATE/Bug_report.md
vendored
Normal file
72
.github/ISSUE_TEMPLATE/Bug_report.md
vendored
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Report an issue you're experiencing
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<!---
|
||||||
|
Thanks for filing a bug report 😄 ! Before you submit, please read the following:
|
||||||
|
|
||||||
|
If you're here to report a security issue, please STOP writing an issue and
|
||||||
|
contact us at security@swagger.io instead!
|
||||||
|
|
||||||
|
Search open/closed issues before submitting!
|
||||||
|
|
||||||
|
Issues on GitHub are only related to problems of Swagger-UI itself. We'll try
|
||||||
|
to offer support here for your 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 bugs in the Swagger/OpenAPIspecifications themselves,
|
||||||
|
or anything that violates the specifications.
|
||||||
|
|
||||||
|
-->
|
||||||
|
|
||||||
|
## Q&A (please complete the following information)
|
||||||
|
- OS: [e.g. macOS]
|
||||||
|
- Browser: [e.g. chrome, safari]
|
||||||
|
- Version: [e.g. 22]
|
||||||
|
- Method of installation: [e.g. npm, dist assets]
|
||||||
|
- Swagger-UI version: [e.g. 3.10.0]
|
||||||
|
- Swagger/OpenAPI version: [e.g. Swagger 2.0, OpenAPI 3.0]
|
||||||
|
|
||||||
|
### Content & configuration
|
||||||
|
<!--
|
||||||
|
Provide us with a way to see what you're seeing,
|
||||||
|
so that we can fix your issue.
|
||||||
|
-->
|
||||||
|
|
||||||
|
Example Swagger/OpenAPI definition:
|
||||||
|
```yaml
|
||||||
|
# your YAML here
|
||||||
|
```
|
||||||
|
|
||||||
|
Swagger-UI configuration options:
|
||||||
|
```js
|
||||||
|
SwaggerUI({
|
||||||
|
// your config options here
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
?yourQueryStringConfig
|
||||||
|
```
|
||||||
|
|
||||||
|
### Describe the bug you're encountering
|
||||||
|
<!-- A clear and concise description of what the bug is. -->
|
||||||
|
|
||||||
|
### To reproduce...
|
||||||
|
|
||||||
|
Steps to reproduce the behavior:
|
||||||
|
1. Go to '...'
|
||||||
|
2. Click on '....'
|
||||||
|
3. Scroll down to '....'
|
||||||
|
4. See error
|
||||||
|
|
||||||
|
### Expected behavior
|
||||||
|
<!-- A clear and concise description of what you expected to happen. -->
|
||||||
|
|
||||||
|
### Screenshots
|
||||||
|
<!-- If applicable, add screenshots to help explain your problem. -->
|
||||||
|
|
||||||
|
### Additional context or thoughts
|
||||||
|
<!-- Add any other context about the problem here. -->
|
||||||
50
.github/ISSUE_TEMPLATE/Feature_request.md
vendored
Normal file
50
.github/ISSUE_TEMPLATE/Feature_request.md
vendored
Normal file
@@ -0,0 +1,50 @@
|
|||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
about: Suggest an new feature or enhancement for this project
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Q&A (please complete the following information)
|
||||||
|
- OS: [e.g. macOS]
|
||||||
|
- Browser: [e.g. chrome, safari]
|
||||||
|
- Version: [e.g. 22]
|
||||||
|
- Method of installation: [e.g. npm, dist assets]
|
||||||
|
- Swagger-UI version: [e.g. 3.10.0]
|
||||||
|
- Swagger/OpenAPI version: [e.g. Swagger 2.0, OpenAPI 3.0]
|
||||||
|
|
||||||
|
### Content & configuration
|
||||||
|
|
||||||
|
Swagger/OpenAPI definition:
|
||||||
|
```yaml
|
||||||
|
# your YAML here
|
||||||
|
```
|
||||||
|
|
||||||
|
Swagger-UI configuration options:
|
||||||
|
```js
|
||||||
|
SwaggerUI({
|
||||||
|
// your config options here
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
?yourQueryStringConfig
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Is your feature request related to a problem?
|
||||||
|
<!--
|
||||||
|
Please provide a clear and concise description of what the problem is.
|
||||||
|
"I'm always frustrated when..."
|
||||||
|
-->
|
||||||
|
|
||||||
|
### Describe the solution you'd like
|
||||||
|
<!-- A clear and concise description of what you want to happen. -->
|
||||||
|
|
||||||
|
### Describe alternatives you've considered
|
||||||
|
<!--
|
||||||
|
A clear and concise description of any alternative solutions or features
|
||||||
|
you've considered.
|
||||||
|
-->
|
||||||
|
|
||||||
|
### Additional context
|
||||||
|
<!-- Add any other context or screenshots about the feature request here. -->
|
||||||
46
.github/ISSUE_TEMPLATE/Support.md
vendored
Normal file
46
.github/ISSUE_TEMPLATE/Support.md
vendored
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
---
|
||||||
|
name: Support
|
||||||
|
about: Ask a question or request help with your implementation.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<!--
|
||||||
|
We can only offer support for Swagger-UI itself.
|
||||||
|
|
||||||
|
If you're having a problem with a library that uses Swagger-UI
|
||||||
|
(for example, Springfox or swagger-node), please open an issue
|
||||||
|
in that project's repository instead.
|
||||||
|
-->
|
||||||
|
|
||||||
|
### Q&A (please complete the following information)
|
||||||
|
- OS: [e.g. macOS]
|
||||||
|
- Browser: [e.g. chrome, safari]
|
||||||
|
- Version: [e.g. 22]
|
||||||
|
- Method of installation: [e.g. npm, dist assets]
|
||||||
|
- Swagger-UI version: [e.g. 3.10.0]
|
||||||
|
- Swagger/OpenAPI version: [e.g. Swagger 2.0, OpenAPI 3.0]
|
||||||
|
|
||||||
|
### Content & configuration
|
||||||
|
<!-- Provide us with a way to see what you're seeing, so that we can help. -->
|
||||||
|
|
||||||
|
Swagger/OpenAPI definition:
|
||||||
|
```yaml
|
||||||
|
# your YAML here
|
||||||
|
```
|
||||||
|
|
||||||
|
Swagger-UI configuration options:
|
||||||
|
```js
|
||||||
|
SwaggerUI({
|
||||||
|
// your config options here
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
?yourQueryStringConfig
|
||||||
|
```
|
||||||
|
|
||||||
|
### Screenshots
|
||||||
|
<!-- If applicable, add screenshots to help give context to your problem. -->
|
||||||
|
|
||||||
|
### How can we help?
|
||||||
|
<!-- Your question or problem goes here! -->
|
||||||
70
.github/issue_template.md
vendored
70
.github/issue_template.md
vendored
@@ -1,70 +0,0 @@
|
|||||||
<!---
|
|
||||||
Thanks for filing an issue 😄 ! Before you submit, please read the following:
|
|
||||||
|
|
||||||
If you're here to report a security issue, please STOP writing an issue and contact us
|
|
||||||
at security@swagger.io instead!
|
|
||||||
|
|
||||||
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 your 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 -->
|
|
||||||
|
|
||||||
<!---
|
|
||||||
If you aren't sure what Swagger-UI version, see this guide: https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/version-detection.md
|
|
||||||
--->
|
|
||||||
|
|
||||||
|
|
||||||
| Q | A
|
|
||||||
| ------------------------------- | -------
|
|
||||||
| Bug or feature request? |
|
|
||||||
| Which Swagger/OpenAPI version? |
|
|
||||||
| Which Swagger-UI version? |
|
|
||||||
| How did you install Swagger-UI? |
|
|
||||||
| Which browser & version? |
|
|
||||||
| Which operating system? |
|
|
||||||
|
|
||||||
|
|
||||||
### Demonstration API definition
|
|
||||||
<!--- If you're describing a bug, please provide an API definition that reproduces your problem -->
|
|
||||||
<!--- If you have link to a demo repo please link that! -->
|
|
||||||
|
|
||||||
<!--- If your spec is large, please put it into a Gist (https://gist.github.com) instead of pasting it here. -->
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
your: "API definition 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