From 6aabd9f462601afb3a33c0704c88d218cfc032dc Mon Sep 17 00:00:00 2001 From: Michael Ripperger Date: Mon, 16 Dec 2024 11:10:19 -0600 Subject: [PATCH] Fix issue templates (#1087) * Fixed bug report * Converted feature request template to YAML * Minor updates to issue templates --- .github/ISSUE_TEMPLATE/bug-report.yml | 24 ++++++++-------- .github/ISSUE_TEMPLATE/feature-request.yml | 32 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 -------------- 3 files changed, 44 insertions(+), 32 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index e6a1354f62d..3ad882cc8f9 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,9 +1,5 @@ -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - +name: Bug Report +description: Create a report to help us improve body: - type: input attributes: @@ -26,8 +22,8 @@ body: - Windows (MSVC 2019) - Windows (MSVC 2022) - Other (please specify in the bug description) - validations: - required: True + validations: + required: True - type: textarea attributes: @@ -40,18 +36,22 @@ body: - type: textarea attributes: label: To Reproduce - placeholder: | + placeholder: | Describe the steps to reproduce the behavior + validations: + required: True - type: textarea attributes: label: Expected behavior - value: | + placeholder: | A clear and concise description of what you expected to happen. + validations: + required: True - type: textarea attributes: label: Relevant log output placeholder: | - Paste log output here - render: bash + Paste any relevant log output here (will be rendered as shell text) + render: shell diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 00000000000..3c90dccf65e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,32 @@ +name: Feature Request +description: Suggest an idea for this project +body: + - type: textarea + attributes: + label: Is your feature request related to a problem? Please describe. + placeholder: | + A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: True + + - type: textarea + attributes: + label: Describe the solution you'd like + placeholder: | + A clear and concise description of what you want to happen. + validations: + required: True + + - type: textarea + attributes: + label: Describe alternatives you've considered + placeholder: | + A clear and concise description of any alternative solutions or features you've considered. + validations: + required: True + + - type: textarea + attributes: + label: Additional context + placeholder: | + Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7d615..00000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. 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.