From 329537fe8f7d6f654af7c8daa88af79c88daeab6 Mon Sep 17 00:00:00 2001 From: "costellobot[bot]" <102247573+costellobot[bot]@users.noreply.github.com> Date: Sat, 3 May 2025 16:13:41 +0000 Subject: [PATCH 1/2] Use GitHub Issue forms Update issues to use [GitHub Issue forms](https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms). Contributes to https://github.com/martincostello/repo-migrations/issues/94. Signed-off-by: costellobot[bot] <102247573+costellobot[bot]@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/10_bug_report.yml | 74 +++++++++++++++++++ .github/ISSUE_TEMPLATE/20_feature_request.yml | 30 ++++++++ .github/ISSUE_TEMPLATE/30_question.yml | 31 ++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 50 ------------- 4 files changed, 135 insertions(+), 50 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/10_bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/20_feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/30_question.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/10_bug_report.yml b/.github/ISSUE_TEMPLATE/10_bug_report.yml new file mode 100644 index 00000000..91178de1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/10_bug_report.yml @@ -0,0 +1,74 @@ +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. + + If you're not using the latest release, please try upgrading to the latest version first to see if the issue resolves itself. +- type: input + attributes: + label: Version + description: Which version of the application are you experiencing the issue with? + placeholder: 1.0.0 + validations: + required: true +- 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: input + attributes: + label: .NET Version + description: | + Run `dotnet --version` to get the .NET SDK version you're using. + Alternatively, which target framework(s) (e.g. `net8.0`) does the project you're using the package with target? + placeholder: 9.0.100 + 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 - - From b9c5acc2689671c9243016123f4a6ff329c191c5 Mon Sep 17 00:00:00 2001 From: Martin Costello Date: Sat, 3 May 2025 18:45:30 +0100 Subject: [PATCH 2/2] Apply suggestions from code review --- .github/ISSUE_TEMPLATE/10_bug_report.yml | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/10_bug_report.yml b/.github/ISSUE_TEMPLATE/10_bug_report.yml index 91178de1..0c5f8659 100644 --- a/.github/ISSUE_TEMPLATE/10_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/10_bug_report.yml @@ -7,15 +7,6 @@ body: 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. - - If you're not using the latest release, please try upgrading to the latest version first to see if the issue resolves itself. -- type: input - attributes: - label: Version - description: Which version of the application are you experiencing the issue with? - placeholder: 1.0.0 - validations: - required: true - type: textarea attributes: label: Describe the bug @@ -54,15 +45,6 @@ body: render: text validations: required: false -- type: input - attributes: - label: .NET Version - description: | - Run `dotnet --version` to get the .NET SDK version you're using. - Alternatively, which target framework(s) (e.g. `net8.0`) does the project you're using the package with target? - placeholder: 9.0.100 - validations: - required: false - type: textarea attributes: label: Anything else?