From 39a749da1e192a067033f3f5e35178317ea44754 Mon Sep 17 00:00:00 2001 From: Simon Kurtz Date: Tue, 27 May 2025 15:55:11 -0400 Subject: [PATCH] Switch to Yaml templates, add feature request --- .github/ISSUE_TEMPLATE/bug_report.md | 35 ------- .github/ISSUE_TEMPLATE/bug_report.yml | 102 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 42 +++++++++ 3 files changed, 144 insertions(+), 35 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index dd0bbea..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG] " -labels: triage -assignees: simonkurtz-MSFT - ---- - -**If you suspect you may have found a security vulnerability, please do not report it publicly. Instead, [please report it privately](https://github.com/Azure-Samples/Apim-Samples/security/advisories/new).** - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Environment (please complete the following information):** - - CPU Architecture [e.g. x86, x64, ARM64] - - OS: [e.g. Windows, Linux, macOS] - - IDE: [e.g. VS Code] - - Python version: [e.g. 3.12] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..2a39c06 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,102 @@ +name: "Bug report" +description: "Create a report to help us improve." +title: "[Bug] " +labels: [triage] +assignees: [simonkurtz-MSFT] + +body: + - type: markdown + attributes: + value: | + **If you suspect you may have found a security vulnerability, please do not report it publicly. Instead, [please report it privately](https://github.com/Azure-Samples/Apim-Samples/security/advisories/new).** + + - type: textarea + id: bug + attributes: + label: "Describe the bug" + description: "A clear and concise description of what the bug is." + placeholder: "Please describe the bug." + validations: + required: true + + - type: textarea + id: steps + attributes: + label: "To Reproduce" + description: "Steps to reproduce the behavior." + placeholder: "1. Go to '...' + 1. Click on '...' + 1. Scroll down to '...' + 1. See error" + validations: + required: true + + - type: textarea + id: expected + attributes: + label: "Expected behavior" + description: "A clear and concise description of what you expected to happen." + placeholder: "Please describe what you expected to happen." + validations: + required: true + + - type: textarea + id: screenshots + attributes: + label: "Screenshots" + description: "If applicable, add screenshots to help explain your problem." + placeholder: "Please paste or drag screenshots here." + validations: + required: false + + - type: checkboxes + id: cpu + attributes: + label: "CPU Architecture" + description: "Select your CPU architecture (select one only). If 'Other', please specify." + options: + - label: "x86" + required: false + - label: "x64" + required: false + - label: "ARM64" + required: false + - label: "Other (please specify below)" + required: false + validations: + required: false + + - type: input + id: cpu_other + attributes: + label: "Other CPU Architecture" + description: "If you selected 'Other' above, please specify your CPU architecture." + placeholder: "e.g. RISC-V, PowerPC, etc." + validations: + required: false + + - type: checkboxes + id: os + attributes: + label: "Operating System" + description: "Select your operating system (select one only). If 'Other', please specify." + options: + - label: "Windows" + required: false + - label: "Linux" + required: false + - label: "macOS" + required: false + - label: "Other (please specify below)" + required: false + validations: + required: false + + - type: input + id: os_other + attributes: + label: "Other Operating System" + description: "If you selected 'Other' above, please specify your OS." + placeholder: "e.g. FreeBSD, Solaris, etc." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..8b976f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,42 @@ +name: "Feature Request" +description: "Suggest a new feature or improvement." +title: "[Feature] " +labels: [triage, feature-request] +assignees: [simonkurtz-MSFT] + +body: + - type: markdown + attributes: + value: | + ## Feature Request + + Please fill out the form below to help us understand your request. + + - type: textarea + id: feature + attributes: + label: "Describe the feature" + description: "What feature are you proposing?" + placeholder: "Please describe the feature you are proposing." + validations: + required: true + + - type: textarea + id: improvement + attributes: + label: "Improvement to Project" + description: "How will it improve this project?" + placeholder: "Please describe how this feature will improve the project." + validations: + required: true + + - type: dropdown + id: collaborate + attributes: + label: "Are you able to collaborate and/or submit a pull request?" + description: "Select one." + options: + - "Yes" + - "No" + validations: + required: true