From 70f53e5d62373337f05b825051033840fee836de Mon Sep 17 00:00:00 2001 From: Kyle Date: Wed, 9 Aug 2017 15:35:11 -0700 Subject: [PATCH 1/3] Update issue template Lifted from the wonderful Babel issue template: https://github.com/babel/babel/issues/new --- .github/issue_template.md | 64 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 61 insertions(+), 3 deletions(-) diff --git a/.github/issue_template.md b/.github/issue_template.md index 1b519695626..7c82949dc3b 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -1,3 +1,61 @@ -When reporting an issue, please provide the following details: -- swagger-ui version -- a swagger file reproducing the issue + + + + + +| 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 + + + +```yaml +your: "spec goes here" +``` + +### Configuration (browser query string, constructor, config.yaml) + + +```js +{ + "your": { "constructorConfig": "here" } +} +``` + +`?yourQueryStringConfig=here` + +### Expected Behavior + + + +### Current Behavior + + + +### Possible Solution + + + +### Context + + From ff8ac0d42eed685c8f840c8db41e14e39e23219e Mon Sep 17 00:00:00 2001 From: Kyle Date: Wed, 9 Aug 2017 15:37:09 -0700 Subject: [PATCH 2/3] LESS typos --- .github/issue_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/issue_template.md b/.github/issue_template.md index 7c82949dc3b..56cdc05f341 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -4,7 +4,7 @@ Thanks for filing an issue 😄 ! Before you submit, please read the following: 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, +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, From c35a904918ee8bce71ca1c0fb0000932f3c7407a Mon Sep 17 00:00:00 2001 From: Kyle Date: Wed, 9 Aug 2017 15:38:49 -0700 Subject: [PATCH 3/3] spec -> API definition --- .github/issue_template.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/issue_template.md b/.github/issue_template.md index 56cdc05f341..9568fa806c7 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -25,12 +25,12 @@ or anything that violates the specifications. | Which operating system? | -### Demonstration spec - +### Demonstration API definition + ```yaml -your: "spec goes here" +your: "API definition goes here" ``` ### Configuration (browser query string, constructor, config.yaml)