From a37d637061b621a1fe2f6126ca32413c7b8401b0 Mon Sep 17 00:00:00 2001 From: kyle Date: Fri, 4 May 2018 12:58:08 -0700 Subject: [PATCH] meta: multiple issue templates (#4519) * MOAR issue templates * ...LESS issue templates --- .github/ISSUE_TEMPLATE/Bug_report.md | 72 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/Feature_request.md | 50 ++++++++++++++++ .github/ISSUE_TEMPLATE/Support.md | 46 +++++++++++++++ .github/issue_template.md | 70 ---------------------- 4 files changed, 168 insertions(+), 70 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/Feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/Support.md delete mode 100644 .github/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md new file mode 100644 index 00000000..2b450d3a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -0,0 +1,72 @@ +--- +name: Bug report +about: Report an issue you're experiencing + +--- + + + +## 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 + + +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 + + +### To reproduce... + +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +### Expected behavior + + +### Screenshots + + +### Additional context or thoughts + diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md new file mode 100644 index 00000000..dea7983a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -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? + + +### Describe the solution you'd like + + +### Describe alternatives you've considered + + +### Additional context + diff --git a/.github/ISSUE_TEMPLATE/Support.md b/.github/ISSUE_TEMPLATE/Support.md new file mode 100644 index 00000000..92eb5e90 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Support.md @@ -0,0 +1,46 @@ +--- +name: Support +about: Ask a question or request help with your implementation. + +--- + + + +### 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 +``` + +### Screenshots + + +### How can we help? + diff --git a/.github/issue_template.md b/.github/issue_template.md deleted file mode 100644 index 142652fd..00000000 --- a/.github/issue_template.md +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - -| 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 - - - - - -```yaml -your: "API definition goes here" -``` - -### Configuration (browser query string, constructor, config.yaml) - - -```js -{ - "your": { "constructorConfig": "here" } -} -``` - -`?yourQueryStringConfig=here` - -### Expected Behavior - - - -### Current Behavior - - - -### Possible Solution - - - -### Context - - -- GitLab