Skip to content

Commit

Permalink
Updating issue templates (#22273)
Browse files Browse the repository at this point in the history
* Updating issue templates

* Address feedback
  • Loading branch information
woody-apple authored and pull[bot] committed Oct 18, 2023
1 parent 2100315 commit 2881285
Show file tree
Hide file tree
Showing 6 changed files with 326 additions and 11 deletions.
11 changes: 0 additions & 11 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
name: "\U0001F41B Bug report"
description: Create a report to help Matter
title: "[BUG] "
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."
value: |
1.
2.
3.
...
render: bash
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.0.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 bug!"
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/100-documentation-issue.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: "\U0001F5BA Documentation Issue"
description: Create an issue to improve documentation
title: "[Documentation] "
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: Documentation issues
description: "What updates to documentation are needed?"
value: |
1.
2.
3.
...
render: bash
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 (please add to version below)
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!
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 documentation issue!"
95 changes: 95 additions & 0 deletions .github/ISSUE_TEMPLATE/2-1.0-issue.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
name: "\U0001F41B 1.0 Issue"
description: Create an issue that is required for Matter 1.0 release
title: "[1.0] "
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."
value: |
1.
2.
3.
...
render: bash
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.0.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 submitting a bug!"
95 changes: 95 additions & 0 deletions .github/ISSUE_TEMPLATE/3-sve-1.0-issue.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
name: "\U0001F41B SVE Issue"
description: Create an issue that is required for SVE
title: "[SVE] "
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."
value: |
1.
2.
3.
...
render: bash
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 (please add to version below)
validations:
required: true
- type: input
id: platform-versions
attributes:
label: Platform Version(s)
description: "What platform version(s) are affected [optional]"
placeholder: "eg: 1.0.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 submitting a bug!"
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false

0 comments on commit 2881285

Please sign in to comment.