diff --git a/.github/ISSUE_TEMPLATE/10_bug_report.yml b/.github/ISSUE_TEMPLATE/10_bug_report.yml new file mode 100644 index 00000000..0c5f8659 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/10_bug_report.yml @@ -0,0 +1,56 @@ +name: πŸ› Bug report +description: Something not behaving as expected? +title: '[Bug]: ' +labels: ['bug'] +body: +- type: markdown + attributes: + value: | + Please check for an existing issue and the [README](https://github.com/martincostello/aspnetcore-openapi/blob/main/README.md) before submitting a bug report. +- type: textarea + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + validations: + required: true +- type: textarea + attributes: + label: Expected behaviour + description: A clear and concise description of what you expected to happen. + validations: + required: false +- type: textarea + attributes: + label: Actual behaviour + description: What actually happens. + validations: + required: false +- type: textarea + attributes: + label: Steps to reproduce + description: | + Provide a link to a [minimalistic project which reproduces this issue (repro)](https://stackoverflow.com/help/mcve) hosted in a **public** GitHub repository. + Code snippets, such as a failing unit test or small console app, which demonstrate the issue wrapped in a [fenced code block](https://docs.github.com/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks) are also acceptable. + + This issue will be closed if: + - The behaviour you're reporting cannot be easily reproduced. + - The issue is a duplicate of an existing issue. + - The behaviour you're reporting is by design. + validations: + required: false +- type: textarea + attributes: + label: Exception(s) (if any) + description: Include any exception(s) and/or stack trace(s) you get when facing this issue. + render: text + validations: + required: false +- type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering is useful. + + πŸ’‘Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/20_feature_request.yml b/.github/ISSUE_TEMPLATE/20_feature_request.yml new file mode 100644 index 00000000..82860d3a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/20_feature_request.yml @@ -0,0 +1,30 @@ +name: πŸ’‘ Feature request +description: Suggest a feature request or improvement +title: '[Feature request]: ' +labels: ['feature-request'] +body: +- type: markdown + attributes: + value: | + Please check for an existing issue and the [README](https://github.com/martincostello/aspnetcore-openapi/blob/main/README.md) before submitting a feature request. +- type: textarea + attributes: + label: Is your feature request related to a specific problem? Or an existing feature? + description: A clear and concise description of what the problem is. Motivating examples help prioritise things. + placeholder: I am trying to [...] but [...] + validations: + required: true +- type: textarea + attributes: + label: Describe the solution you'd like + description: | + A clear and concise description of what you want to happen. Include any alternative solutions you've considered. + validations: + required: true +- type: textarea + attributes: + label: Additional context + description: | + Add any other context or screenshots about the feature request here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/30_question.yml b/.github/ISSUE_TEMPLATE/30_question.yml new file mode 100644 index 00000000..50da3418 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/30_question.yml @@ -0,0 +1,31 @@ +name: πŸ€” Question? +description: You have something specific to achieve and the existing documentation hasn't covered how. +title: '[Question]: ' +labels: ['question'] +body: +- type: markdown + attributes: + value: | + Please check for an existing issue and the [README](https://github.com/martincostello/aspnetcore-openapi/blob/main/README.md) before asking a question. +- type: textarea + attributes: + label: What do you want to achieve? + description: A clear and concise description of what you're trying to do. + placeholder: I am trying to [...] but [...] + validations: + required: true +- type: textarea + attributes: + label: What code or approach do you have so far? + description: | + Provide a [minimalistic project which shows what you have so far](https://stackoverflow.com/help/mcve) hosted in a **public** GitHub repository. + Code snippets wrapped in a [fenced code block](https://docs.github.com/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks) are also acceptable. + validations: + required: true +- type: textarea + attributes: + label: Additional context + description: | + Add any other context or screenshots related to your question here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index f474bf29..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -name: Bug report -title: Bug report -about: Create a bug report to help us improve the sample -labels: bug ---- - -### Describe the bug - - - -### Steps To reproduce - - - -### Expected behaviour - - - -### Actual behaviour - - - -### Screenshots - - - -### System information - - - -### Additional context - -