Skip to content

Commit e535710

Browse files
woody-applewoody-apple
authored
Updating issue templates (#22273)
* Updating issue templates * Address feedback
1 parent 2a47aee commit e535710

6 files changed

+326
-11
lines changed

‎.github/ISSUE_TEMPLATE.md

-11
This file was deleted.

‎.github/ISSUE_TEMPLATE/1-bug-report.yaml

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: "\U0001F41B Bug report"
2+
description: Create a report to help Matter
3+
title: "[BUG] "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
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.
9+
- type: textarea
10+
id: repro
11+
attributes:
12+
label: Reproduction steps
13+
description: "How do you trigger this bug? Please walk us through it step by step."
14+
value: |
15+
1.
16+
2.
17+
3.
18+
...
19+
render: bash
20+
validations:
21+
required: true
22+
- type: input
23+
id: prevalence
24+
attributes:
25+
label: Bug prevalence
26+
description: "How often do you or others encounter this bug?"
27+
placeholder: "Example: Whenever I do this, 1-2 times a week, day, hour, etc"
28+
validations:
29+
required: true
30+
- type: input
31+
attributes:
32+
label: GitHub hash of the SDK that was being used
33+
description: Hash of the GitHub SDK used
34+
validations:
35+
required: true
36+
- type: dropdown
37+
attributes:
38+
label: Platform
39+
description: What platforms are affected?
40+
multiple: true
41+
options:
42+
- ameba
43+
- android
44+
- cc13x2_cc26x2
45+
- darwin
46+
- efr32
47+
- esp32
48+
- freeRTOS
49+
- IMX8
50+
- k32w
51+
- nrf
52+
- python
53+
- raspi
54+
- vscode
55+
- windows
56+
- other
57+
- core
58+
validations:
59+
required: true
60+
- type: input
61+
id: platform-versions
62+
attributes:
63+
label: Platform Version(s)
64+
description: "What platform version(s) are affected [optional]"
65+
placeholder: "eg: 1.0.1, N/A"
66+
- type: textarea
67+
attributes:
68+
label: Anything else?
69+
description: |
70+
Links? References? Anything that will give us more context about the issue you are encountering!
71+
72+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
73+
validations:
74+
required: false
75+
- type: markdown
76+
attributes:
77+
value: "Thanks for submitting a bug!"

‎.github/ISSUE_TEMPLATE/100-documentation-issue.yaml

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: "\U0001F5BA Documentation Issue"
2+
description: Create an issue to improve documentation
3+
title: "[Documentation] "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
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.
9+
- type: textarea
10+
id: repro
11+
attributes:
12+
label: Documentation issues
13+
description: "What updates to documentation are needed?"
14+
value: |
15+
1.
16+
2.
17+
3.
18+
...
19+
render: bash
20+
validations:
21+
required: true
22+
- type: dropdown
23+
attributes:
24+
label: Platform
25+
description: What platforms are affected?
26+
multiple: true
27+
options:
28+
- ameba
29+
- android
30+
- cc13x2_cc26x2
31+
- darwin
32+
- efr32
33+
- esp32
34+
- freeRTOS
35+
- IMX8
36+
- k32w
37+
- nrf connect
38+
- nrf
39+
- python
40+
- raspi
41+
- vscode
42+
- windows
43+
- other
44+
- core (please add to version below)
45+
validations:
46+
required: false
47+
- type: textarea
48+
attributes:
49+
label: Anything else?
50+
description: |
51+
Links? References? Anything that will give us more context about the issue you are encountering!
52+
53+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
54+
validations:
55+
required: false
56+
- type: markdown
57+
attributes:
58+
value: "Thanks for submitting a documentation issue!"

‎.github/ISSUE_TEMPLATE/2-1.0-issue.yaml

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
name: "\U0001F41B 1.0 Issue"
2+
description: Create an issue that is required for Matter 1.0 release
3+
title: "[1.0] "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
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.
9+
- type: textarea
10+
id: repro
11+
attributes:
12+
label: Reproduction steps
13+
description: "How do you trigger this bug? Please walk us through it step by step."
14+
value: |
15+
1.
16+
2.
17+
3.
18+
...
19+
render: bash
20+
validations:
21+
required: true
22+
- type: input
23+
id: prevalence
24+
attributes:
25+
label: Bug prevalence
26+
description: "How often do you or others encounter this bug?"
27+
placeholder: "Example: Whenever I do this, 1-2 times a week, day, hour, etc"
28+
validations:
29+
required: true
30+
- type: input
31+
attributes:
32+
label: GitHub hash of the SDK that was being used
33+
description: Hash of the GitHub SDK used
34+
validations:
35+
required: true
36+
- type: dropdown
37+
attributes:
38+
label: Platform
39+
description: What platforms are affected?
40+
multiple: true
41+
options:
42+
- ameba
43+
- android
44+
- cc13x2_cc26x2
45+
- darwin
46+
- efr32
47+
- esp32
48+
- freeRTOS
49+
- IMX8
50+
- k32w
51+
- nrf connect
52+
- nrf
53+
- python
54+
- raspi
55+
- vscode
56+
- windows
57+
- other
58+
- core
59+
validations:
60+
required: true
61+
- type: input
62+
id: platform-versions
63+
attributes:
64+
label: Platform Version(s)
65+
description: "What platform version(s) are affected [optional]"
66+
placeholder: "eg: 1.0.1, N/A"
67+
- type: dropdown
68+
attributes:
69+
label: Type
70+
description: What type of issue is this?
71+
multiple: true
72+
options:
73+
- Test Improvement
74+
- Common Cluster Logic
75+
- Spec Compliance Issue
76+
- Security Issue
77+
- Platform Issue
78+
- Core SDK Memory Issue
79+
- Core SDK Crash
80+
- Core SDK Performance Improvement
81+
- Core SDK Interopability Issue
82+
validations:
83+
required: true
84+
- type: textarea
85+
attributes:
86+
label: Anything else?
87+
description: |
88+
Links? References? Anything that will give us more context about the issue you are encountering!
89+
90+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
91+
validations:
92+
required: false
93+
- type: markdown
94+
attributes:
95+
value: "Thanks for submitting a bug!"

‎.github/ISSUE_TEMPLATE/3-sve-1.0-issue.yaml

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
name: "\U0001F41B SVE Issue"
2+
description: Create an issue that is required for SVE
3+
title: "[SVE] "
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
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.
9+
- type: textarea
10+
id: repro
11+
attributes:
12+
label: Reproduction steps
13+
description: "How do you trigger this bug? Please walk us through it step by step."
14+
value: |
15+
1.
16+
2.
17+
3.
18+
...
19+
render: bash
20+
validations:
21+
required: true
22+
- type: input
23+
id: prevalence
24+
attributes:
25+
label: Bug prevalence
26+
description: "How often do you or others encounter this bug?"
27+
placeholder: "Example: Whenever I do this, 1-2 times a week, day, hour, etc"
28+
validations:
29+
required: true
30+
- type: input
31+
attributes:
32+
label: GitHub hash of the SDK that was being used
33+
description: Hash of the GitHub SDK used
34+
validations:
35+
required: true
36+
- type: dropdown
37+
attributes:
38+
label: Platform
39+
description: What platforms are affected?
40+
multiple: true
41+
options:
42+
- ameba
43+
- android
44+
- cc13x2_cc26x2
45+
- darwin
46+
- efr32
47+
- esp32
48+
- freeRTOS
49+
- IMX8
50+
- k32w
51+
- nrf connect
52+
- nrf
53+
- python
54+
- raspi
55+
- vscode
56+
- windows
57+
- other
58+
- core (please add to version below)
59+
validations:
60+
required: true
61+
- type: input
62+
id: platform-versions
63+
attributes:
64+
label: Platform Version(s)
65+
description: "What platform version(s) are affected [optional]"
66+
placeholder: "eg: 1.0.1, N/A"
67+
- type: dropdown
68+
attributes:
69+
label: Type
70+
description: What type of issue is this?
71+
multiple: true
72+
options:
73+
- Test Improvement
74+
- Common Cluster Logic
75+
- Spec Compliance Issue
76+
- Security Issue
77+
- Platform Issue
78+
- Core SDK Memory Issue
79+
- Core SDK Crash
80+
- Core SDK Performance Improvement
81+
- Core SDK Interopability Issue
82+
validations:
83+
required: true
84+
- type: textarea
85+
attributes:
86+
label: Anything else?
87+
description: |
88+
Links? References? Anything that will give us more context about the issue you are encountering!
89+
90+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
91+
validations:
92+
required: false
93+
- type: markdown
94+
attributes:
95+
value: "Thanks for submitting a bug!"

‎.github/ISSUE_TEMPLATE/config.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

0 commit comments

Comments
 (0)