From 23733419675388f74adf4c2c918cf71fefac238f Mon Sep 17 00:00:00 2001 From: Justin Wood Date: Tue, 20 Jun 2023 13:10:31 -0400 Subject: [PATCH] Updating issue templates (#27353) Co-authored-by: Boris Zbarsky --- ...{1-bug-report.yaml => 001-bug-report.yaml} | 15 +-- .../{2-1.0-issue.yaml => 002-1.0-issue.yaml} | 15 +-- .github/ISSUE_TEMPLATE/003-1.1-issue.yaml | 98 +++++++++++++++++++ .github/ISSUE_TEMPLATE/004-1.2-issue.yaml | 98 +++++++++++++++++++ .github/ISSUE_TEMPLATE/005-1.3-issue.yaml | 98 +++++++++++++++++++ ...-trivial-fix.yaml => 049-trivial-fix.yaml} | 3 +- ...-tooling-fix.yaml => 050-tooling-fix.yaml} | 17 ++-- ...latform-fix.yaml => 060-platform-fix.yaml} | 15 +-- ...-request.yaml => 080-feature-request.yaml} | 1 + ...-sve-1.0-issue.yaml => 090-sve-issue.yaml} | 17 ++-- .github/ISSUE_TEMPLATE/091-cert-blocker.yaml | 80 +++++++++++++++ ...ue.yaml => 099-github-workflow-issue.yaml} | 1 + .../100-documentation-issue.yaml | 1 + 13 files changed, 421 insertions(+), 38 deletions(-) rename .github/ISSUE_TEMPLATE/{1-bug-report.yaml => 001-bug-report.yaml} (89%) rename .github/ISSUE_TEMPLATE/{2-1.0-issue.yaml => 002-1.0-issue.yaml} (91%) create mode 100644 .github/ISSUE_TEMPLATE/003-1.1-issue.yaml create mode 100644 .github/ISSUE_TEMPLATE/004-1.2-issue.yaml create mode 100644 .github/ISSUE_TEMPLATE/005-1.3-issue.yaml rename .github/ISSUE_TEMPLATE/{70-trivial-fix.yaml => 049-trivial-fix.yaml} (98%) rename .github/ISSUE_TEMPLATE/{50-tooling-fix.yaml => 050-tooling-fix.yaml} (89%) rename .github/ISSUE_TEMPLATE/{60-platform-fix.yaml => 060-platform-fix.yaml} (90%) rename .github/ISSUE_TEMPLATE/{80-feature-request.yaml => 080-feature-request.yaml} (96%) rename .github/ISSUE_TEMPLATE/{3-sve-1.0-issue.yaml => 090-sve-issue.yaml} (91%) create mode 100644 .github/ISSUE_TEMPLATE/091-cert-blocker.yaml rename .github/ISSUE_TEMPLATE/{99-github-workflow-issue.yaml => 099-github-workflow-issue.yaml} (97%) diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yaml b/.github/ISSUE_TEMPLATE/001-bug-report.yaml similarity index 89% rename from .github/ISSUE_TEMPLATE/1-bug-report.yaml rename to .github/ISSUE_TEMPLATE/001-bug-report.yaml index 3e30ed6dd3088c..8944e002c5ecc3 100644 --- a/.github/ISSUE_TEMPLATE/1-bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/001-bug-report.yaml @@ -1,6 +1,7 @@ name: "\U0001F41B Bug report" description: Create a report to help Matter title: "[BUG] " +labels: [bug, "needs triage"] body: - type: markdown attributes: @@ -12,13 +13,13 @@ body: label: Reproduction steps description: "How do you trigger this bug? Please walk us through it step by step." placeholder: | - Please list reproduction steps step by step. - Place shell commands between ```. - Attach logs as files instead of pasting them in. - 1. - 2. - 3. - ... + Please list reproduction steps step by step. + Place shell commands between ```. + Attach logs as files instead of pasting them in. + 1. + 2. + 3. + ... validations: required: true - type: input diff --git a/.github/ISSUE_TEMPLATE/2-1.0-issue.yaml b/.github/ISSUE_TEMPLATE/002-1.0-issue.yaml similarity index 91% rename from .github/ISSUE_TEMPLATE/2-1.0-issue.yaml rename to .github/ISSUE_TEMPLATE/002-1.0-issue.yaml index 93fbf8bec7e533..78c0e9cf10a766 100644 --- a/.github/ISSUE_TEMPLATE/2-1.0-issue.yaml +++ b/.github/ISSUE_TEMPLATE/002-1.0-issue.yaml @@ -1,6 +1,7 @@ name: "\U0001F680 1.0 Issue" description: Create an issue that is required for Matter 1.0 release title: "[1.0] " +labels: [bug, "V1.0", "needs triage"] body: - type: markdown attributes: @@ -12,13 +13,13 @@ body: label: Reproduction steps description: "How do you trigger this bug? Please walk us through it step by step." placeholder: | - Please list reproduction steps step by step. - Place shell commands between ```. - Attach logs as files instead of pasting them in. - 1. - 2. - 3. - ... + Please list reproduction steps step by step. + Place shell commands between ```. + Attach logs as files instead of pasting them in. + 1. + 2. + 3. + ... validations: required: true - type: input diff --git a/.github/ISSUE_TEMPLATE/003-1.1-issue.yaml b/.github/ISSUE_TEMPLATE/003-1.1-issue.yaml new file mode 100644 index 00000000000000..cd6179d91fe6c7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/003-1.1-issue.yaml @@ -0,0 +1,98 @@ +name: "\U0001F680 1.1 Issue" +description: Create an issue that is required for Matter 1.1 release +title: "[1.1] " +labels: [bug, "V1.1", "needs triage"] +body: + - type: markdown + attributes: + value: | + Thanks for reporting an issue against the Matter SDK! We need information about the bug report to follow up, so please help us out by filling out this information. + - type: textarea + id: repro + attributes: + label: Reproduction steps + description: "How do you trigger this bug? Please walk us through it step by step." + placeholder: | + Please list reproduction steps step by step. + Place shell commands between ```. + Attach logs as files instead of pasting them in. + 1. + 2. + 3. + ... + validations: + required: true + - type: input + id: prevalence + attributes: + label: Bug prevalence + description: "How often do you or others encounter this bug?" + placeholder: "Example: Whenever I do this, 1-2 times a week, day, hour, etc" + validations: + required: true + - type: input + attributes: + label: GitHub hash of the SDK that was being used + description: Hash of the GitHub SDK used + validations: + required: true + - type: dropdown + attributes: + label: Platform + description: What platforms are affected? + multiple: true + options: + - ameba + - android + - cc13x2_cc26x2 + - darwin + - efr32 + - esp32 + - freeRTOS + - IMX8 + - k32w + - nrf connect + - nrf + - python + - raspi + - vscode + - windows + - other + - core + validations: + required: true + - type: input + id: platform-versions + attributes: + label: Platform Version(s) + description: "What platform version(s) are affected [optional]" + placeholder: "eg: 1.1, N/A" + - type: dropdown + attributes: + label: Type + description: What type of issue is this? + multiple: true + options: + - Test Improvement + - Common Cluster Logic + - Spec Compliance Issue + - Security Issue + - Platform Issue + - Core SDK Memory Issue + - Core SDK Crash + - Core SDK Performance Improvement + - Core SDK Interopability Issue + validations: + required: true + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: markdown + attributes: + value: "Thanks for helping us get to 1.1!" diff --git a/.github/ISSUE_TEMPLATE/004-1.2-issue.yaml b/.github/ISSUE_TEMPLATE/004-1.2-issue.yaml new file mode 100644 index 00000000000000..dd67cd7addbdea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/004-1.2-issue.yaml @@ -0,0 +1,98 @@ +name: "\U0001F680 1.2 Issue" +description: Create an issue that is required for Matter 1.2 release +title: "[1.2] " +labels: [bug, "V1.2", "needs triage"] +body: + - type: markdown + attributes: + value: | + Thanks for reporting an issue against the Matter SDK! We need information about the bug report to follow up, so please help us out by filling out this information. + - type: textarea + id: repro + attributes: + label: Reproduction steps + description: "How do you trigger this bug? Please walk us through it step by step." + placeholder: | + Please list reproduction steps step by step. + Place shell commands between ```. + Attach logs as files instead of pasting them in. + 1. + 2. + 3. + ... + validations: + required: true + - type: input + id: prevalence + attributes: + label: Bug prevalence + description: "How often do you or others encounter this bug?" + placeholder: "Example: Whenever I do this, 1-2 times a week, day, hour, etc" + validations: + required: true + - type: input + attributes: + label: GitHub hash of the SDK that was being used + description: Hash of the GitHub SDK used + validations: + required: true + - type: dropdown + attributes: + label: Platform + description: What platforms are affected? + multiple: true + options: + - ameba + - android + - cc13x2_cc26x2 + - darwin + - efr32 + - esp32 + - freeRTOS + - IMX8 + - k32w + - nrf connect + - nrf + - python + - raspi + - vscode + - windows + - other + - core + validations: + required: true + - type: input + id: platform-versions + attributes: + label: Platform Version(s) + description: "What platform version(s) are affected [optional]" + placeholder: "eg: 1.2, N/A" + - type: dropdown + attributes: + label: Type + description: What type of issue is this? + multiple: true + options: + - Test Improvement + - Common Cluster Logic + - Spec Compliance Issue + - Security Issue + - Platform Issue + - Core SDK Memory Issue + - Core SDK Crash + - Core SDK Performance Improvement + - Core SDK Interopability Issue + validations: + required: true + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: markdown + attributes: + value: "Thanks for helping us get to 1.2!" diff --git a/.github/ISSUE_TEMPLATE/005-1.3-issue.yaml b/.github/ISSUE_TEMPLATE/005-1.3-issue.yaml new file mode 100644 index 00000000000000..a904231a9e6020 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/005-1.3-issue.yaml @@ -0,0 +1,98 @@ +name: "\U0001F680 1.3 Issue" +description: Create an issue that is required for Matter 1.3 release +title: "[1.3] " +labels: [bug, "V1.3", "needs triage"] +body: + - type: markdown + attributes: + value: | + Thanks for reporting an issue against the Matter SDK! We need information about the bug report to follow up, so please help us out by filling out this information. + - type: textarea + id: repro + attributes: + label: Reproduction steps + description: "How do you trigger this bug? Please walk us through it step by step." + placeholder: | + Please list reproduction steps step by step. + Place shell commands between ```. + Attach logs as files instead of pasting them in. + 1. + 2. + 3. + ... + validations: + required: true + - type: input + id: prevalence + attributes: + label: Bug prevalence + description: "How often do you or others encounter this bug?" + placeholder: "Example: Whenever I do this, 1-2 times a week, day, hour, etc" + validations: + required: true + - type: input + attributes: + label: GitHub hash of the SDK that was being used + description: Hash of the GitHub SDK used + validations: + required: true + - type: dropdown + attributes: + label: Platform + description: What platforms are affected? + multiple: true + options: + - ameba + - android + - cc13x2_cc26x2 + - darwin + - efr32 + - esp32 + - freeRTOS + - IMX8 + - k32w + - nrf connect + - nrf + - python + - raspi + - vscode + - windows + - other + - core + validations: + required: true + - type: input + id: platform-versions + attributes: + label: Platform Version(s) + description: "What platform version(s) are affected [optional]" + placeholder: "eg: 1.3, N/A" + - type: dropdown + attributes: + label: Type + description: What type of issue is this? + multiple: true + options: + - Test Improvement + - Common Cluster Logic + - Spec Compliance Issue + - Security Issue + - Platform Issue + - Core SDK Memory Issue + - Core SDK Crash + - Core SDK Performance Improvement + - Core SDK Interopability Issue + validations: + required: true + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: markdown + attributes: + value: "Thanks for helping us get to 1.3!" diff --git a/.github/ISSUE_TEMPLATE/70-trivial-fix.yaml b/.github/ISSUE_TEMPLATE/049-trivial-fix.yaml similarity index 98% rename from .github/ISSUE_TEMPLATE/70-trivial-fix.yaml rename to .github/ISSUE_TEMPLATE/049-trivial-fix.yaml index dd7108d7c60326..7c82d950e9f7f4 100644 --- a/.github/ISSUE_TEMPLATE/70-trivial-fix.yaml +++ b/.github/ISSUE_TEMPLATE/049-trivial-fix.yaml @@ -1,6 +1,7 @@ name: "\U0001F3C3 Trivial Fix" description: Create an issue for a trivial fix title: "[Trivial] " +labels: [bug, "needs triage"] body: - type: markdown attributes: @@ -59,7 +60,7 @@ body: placeholder: "eg: 1.0.1, N/A" - type: dropdown attributes: - label: Type + label: Testing description: How was this tested? multiple: true options: diff --git a/.github/ISSUE_TEMPLATE/50-tooling-fix.yaml b/.github/ISSUE_TEMPLATE/050-tooling-fix.yaml similarity index 89% rename from .github/ISSUE_TEMPLATE/50-tooling-fix.yaml rename to .github/ISSUE_TEMPLATE/050-tooling-fix.yaml index 74888c105040a9..667c8946b2804e 100644 --- a/.github/ISSUE_TEMPLATE/50-tooling-fix.yaml +++ b/.github/ISSUE_TEMPLATE/050-tooling-fix.yaml @@ -1,6 +1,7 @@ name: "\U0001F3C3 Tooling Fix/Feature" description: Create an issue for a tooling specific fix/feature -title: "[Platform] " +title: "[Tooling] " +labels: ["tools", "needs triage"] body: - type: markdown attributes: @@ -12,13 +13,13 @@ body: label: Reproduction steps / Feature description: "How do you trigger this issue and/or can you please explain this new feature? Please walk us through it step by step." placeholder: | - Please list reproduction steps step by step. - Place shell commands between ```. - Attach logs as files instead of pasting them in. - 1. - 2. - 3. - ... + Please list reproduction steps step by step. + Place shell commands between ```. + Attach logs as files instead of pasting them in. + 1. + 2. + 3. + ... validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/60-platform-fix.yaml b/.github/ISSUE_TEMPLATE/060-platform-fix.yaml similarity index 90% rename from .github/ISSUE_TEMPLATE/60-platform-fix.yaml rename to .github/ISSUE_TEMPLATE/060-platform-fix.yaml index b6878edede4826..691a5cedc6f604 100644 --- a/.github/ISSUE_TEMPLATE/60-platform-fix.yaml +++ b/.github/ISSUE_TEMPLATE/060-platform-fix.yaml @@ -1,6 +1,7 @@ name: "\U0001F9F0 Platform Fix" description: Create an issue for a platform specific fix title: "[Platform] " +labels: ["platform", "needs triage"] body: - type: markdown attributes: @@ -12,13 +13,13 @@ body: label: Reproduction steps description: "How do you trigger this issue? Please walk us through it step by step." placeholder: | - Please list reproduction steps step by step. - Place shell commands between ```. - Attach logs as files instead of pasting them in. - 1. - 2. - 3. - ... + Please list reproduction steps step by step. + Place shell commands between ```. + Attach logs as files instead of pasting them in. + 1. + 2. + 3. + ... validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/80-feature-request.yaml b/.github/ISSUE_TEMPLATE/080-feature-request.yaml similarity index 96% rename from .github/ISSUE_TEMPLATE/80-feature-request.yaml rename to .github/ISSUE_TEMPLATE/080-feature-request.yaml index e62a5a02415c6b..c83b0c22acaa98 100644 --- a/.github/ISSUE_TEMPLATE/80-feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/080-feature-request.yaml @@ -1,6 +1,7 @@ name: "\U0001F4A1 Feature Request" description: Create an feature to be considered future release title: "[Feature] " +labels: ["feature work", "feature request", "needs triage"] body: - type: markdown attributes: diff --git a/.github/ISSUE_TEMPLATE/3-sve-1.0-issue.yaml b/.github/ISSUE_TEMPLATE/090-sve-issue.yaml similarity index 91% rename from .github/ISSUE_TEMPLATE/3-sve-1.0-issue.yaml rename to .github/ISSUE_TEMPLATE/090-sve-issue.yaml index 340e9ff38aeea6..6ea65341230a35 100644 --- a/.github/ISSUE_TEMPLATE/3-sve-1.0-issue.yaml +++ b/.github/ISSUE_TEMPLATE/090-sve-issue.yaml @@ -1,6 +1,7 @@ name: "\U0001F9EA SVE Issue" description: Create an issue that is required for SVE title: "[SVE] " +labels: [bug, "sve", "request sve", "needs triage"] body: - type: markdown attributes: @@ -12,13 +13,13 @@ body: label: Reproduction steps description: "How do you trigger this bug? Please walk us through it step by step." placeholder: | - Please list reproduction steps step by step. - Place shell commands between ```. - Attach logs as files instead of pasting them in. - 1. - 2. - 3. - ... + Please list reproduction steps step by step. + Place shell commands between ```. + Attach logs as files instead of pasting them in. + 1. + 2. + 3. + ... validations: required: true - type: input @@ -85,7 +86,7 @@ body: required: true - type: dropdown attributes: - label: Type + label: Testing description: How was this tested? multiple: true options: diff --git a/.github/ISSUE_TEMPLATE/091-cert-blocker.yaml b/.github/ISSUE_TEMPLATE/091-cert-blocker.yaml new file mode 100644 index 00000000000000..bf24349cd393be --- /dev/null +++ b/.github/ISSUE_TEMPLATE/091-cert-blocker.yaml @@ -0,0 +1,80 @@ +name: "\U0001F41B Cert Blocker" +description: Create a report to identify matter certification blockers +title: "[CERT-BLOCKER] " +labels: [bug, "cert blocker", "needs triage"] +body: + - type: markdown + attributes: + value: | + Thanks for reporting an issue against the Matter SDK! We need information about the cert blocker to follow up, so please help us out by filling out this information. + - type: textarea + id: repro + attributes: + label: Reproduction steps + description: "How do you trigger this bug? Please walk us through it step by step." + placeholder: | + Please list reproduction steps step by step. + Place shell commands between ```. + Attach logs as files instead of pasting them in. + 1. + 2. + 3. + ... + validations: + required: true + - type: input + id: prevalence + attributes: + label: Bug prevalence + description: "How often do you or others encounter this bug?" + placeholder: "Example: Whenever I do this, 1-2 times a week, day, hour, etc" + validations: + required: true + - type: input + attributes: + label: GitHub hash of the SDK that was being used + description: Hash of the GitHub SDK used + validations: + required: true + - type: dropdown + attributes: + label: Platform + description: What platforms are affected? + multiple: true + options: + - ameba + - android + - cc13x2_cc26x2 + - darwin + - efr32 + - esp32 + - freeRTOS + - IMX8 + - k32w + - nrf + - python + - raspi + - vscode + - windows + - other + - core + validations: + required: true + - type: input + id: platform-versions + attributes: + label: Platform Version(s) + description: "What platform version(s) are affected [optional]" + placeholder: "eg: 1.2.1, N/A" + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: markdown + attributes: + value: "Thanks for submitting a cert blocker!" diff --git a/.github/ISSUE_TEMPLATE/99-github-workflow-issue.yaml b/.github/ISSUE_TEMPLATE/099-github-workflow-issue.yaml similarity index 97% rename from .github/ISSUE_TEMPLATE/99-github-workflow-issue.yaml rename to .github/ISSUE_TEMPLATE/099-github-workflow-issue.yaml index 831a6e6ab14c05..eefa5f0f984c61 100644 --- a/.github/ISSUE_TEMPLATE/99-github-workflow-issue.yaml +++ b/.github/ISSUE_TEMPLATE/099-github-workflow-issue.yaml @@ -1,6 +1,7 @@ name: "\U0001F477 GitHub / CI / Workflow" description: Create an issue to improve CI / Workflows title: "[Workflow] " +labels: ["workflows", "needs triage"] body: - type: markdown attributes: diff --git a/.github/ISSUE_TEMPLATE/100-documentation-issue.yaml b/.github/ISSUE_TEMPLATE/100-documentation-issue.yaml index 69e23c81bd887e..51971d1d010b5f 100644 --- a/.github/ISSUE_TEMPLATE/100-documentation-issue.yaml +++ b/.github/ISSUE_TEMPLATE/100-documentation-issue.yaml @@ -1,6 +1,7 @@ name: "\U0001F5BA Documentation Issue" description: Create an issue to improve documentation title: "[Documentation] " +labels: ["documentation", "needs triage"] body: - type: markdown attributes: