Skip to content

Commit e50084b

Browse files
andy31415restyled-commitsjamesharrow
authored
Start an issue triage document to describe issue owners and maintainance (project-chip#36096)
* Start an issue triage document * Restyle * Restyled by prettier-markdown * Triaged is a word * Move things around, added more notes, removed pyspelling * Update spell check exclude list * Restyled by prettier-markdown * Update docs/issue_triage.md Co-authored-by: jamesharrow <93921463+jamesharrow@users.noreply.github.com> * Cleanup based on review comments * Restyled by prettier-markdown * Add issue triage to the toc tree * Added apple home integration traging notes * Restyle * Fix link * Restyle * attempt to fix links even more ... this doc check is very strict --------- Co-authored-by: Restyled.io <commits@restyled.io> Co-authored-by: jamesharrow <93921463+jamesharrow@users.noreply.github.com>
1 parent 150db87 commit e50084b

File tree

5 files changed

+156
-2
lines changed

5 files changed

+156
-2
lines changed

‎.github/.wordlist.txt

+2
Original file line numberDiff line numberDiff line change
@@ -1452,6 +1452,8 @@ trackFree
14521452
TransferSession
14531453
transitionTime
14541454
TransportMgrBase
1455+
triaged
1456+
triaging
14551457
TriggerEffect
14561458
TRNG
14571459
trustm

‎.spellcheck.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ matrix:
6565
# converts markdown to HTML
6666
- pyspelling.filters.markdown:
6767
sources:
68-
- '**/*.md|!third_party/**|!examples/common/**/repo/**|!docs/ERROR_CODES.md|!docs/clusters.md|!docs/testing/yaml_schema.md|!docs/testing/yaml_pseudocluster.md | !docs/testing/python.md | !docs/testing/ChipDeviceCtrlAPI.md'
68+
- '**/*.md|!third_party/**|!examples/common/**/repo/**|!docs/ERROR_CODES.md|!docs/clusters.md|!docs/testing/yaml_schema.md|!docs/testing/yaml_pseudocluster.md|!docs/testing/python.md|!docs/testing/ChipDeviceCtrlAPI.md|!docs/issue_triage.md'
6969
aspell:
7070
ignore-case: true
7171
camel-case: true

‎docs/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@
1515
[Visual Studio Code](https://code.visualstudio.com/) can be found in
1616
[the development guide](./VSCODE_DEVELOPMENT.md)
1717

18+
## Issue triage
19+
20+
Project issues are triaged and maintained according to the
21+
[issue triage](./issue_triage.md) guide.
22+
1823
## Platform Guides
1924

2025
- Various guides are available [here](./guides/README.md) that cover platform

‎docs/index.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Welcome to Matter's documentation!
1+
# Welcome to Matter's documentation
22

33
```{toctree}
44
:maxdepth: 2
@@ -25,6 +25,7 @@ zap_clusters
2525
spec_clusters
2626
upgrading
2727
ERROR_CODES
28+
issue_triage
2829
2930
```
3031

‎docs/issue_triage.md

+146
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
# Project issues
2+
3+
General issues are listed at
4+
<https://github.com/project-chip/connectedhomeip/issues> .
5+
6+
In order to be able to effectively follow up on these issues, they are separated
7+
into groups for further review and fixing based on current maintainers on
8+
specific areas of the code. The separation is done via `labels`.
9+
10+
Issues that still need triaging are labeled as `needs triage`:
11+
12+
<https://github.com/project-chip/connectedhomeip/issues?q=is%3Aissue+is%3Aopen+label%3A%22needs+triage%22>
13+
14+
## Non-SDK issues
15+
16+
In some cases the issue is integrating with ecosystems or environments are not
17+
supported. In these cases, issues can be re-directed to specific support pages
18+
rather than the SDK GitHub issues.
19+
20+
### Google Integration
21+
22+
- General integration link: <https://developers.home.google.com/matter>
23+
- Support via the communities areas:
24+
- Stack overflow:
25+
<https://stackoverflow.com/questions/tagged/google-smart-home>
26+
- Google Nest Community:
27+
<https://www.googlenestcommunity.com/t5/Smart-Home-Developer-Forum/bd-p/Smart-Home-Developer-Forum>
28+
29+
### Apple Integration
30+
31+
This applies if there is an issue with Home interacting with a device (as
32+
opposed to an issue with Matter.framework or the SDK that is encountered by code
33+
actually running on darwin).
34+
35+
General instructions available at [here](./guides/darwin.md) in the
36+
`Providing feedback to Apple` section.
37+
38+
Once a Feedback Assistant ticket is filed, the ticket ID can be sent to Boris
39+
Zbkarsky to ensure it is noticed by the right people
40+
41+
### Environments not currently supported / not maintained
42+
43+
Some items are explicitly not maintained currently
44+
45+
- Windows integration: no official maintainer for this so currently not
46+
supported
47+
- Old compiler support: CHIP requires a C++17 or higher compiler.
48+
49+
## Platform maintainers
50+
51+
This level of separation is generally for platform-specific issues (e.g. failure
52+
to commission for one specific platform, failure to run on some specific
53+
operating system).
54+
55+
Contact is generally done on slack. E-mail addresses are not added here on
56+
purpose in order to avoid spam.
57+
58+
| Platform | Contact | Label | Note(s) |
59+
| ------------ | --------------------------------------- | -------------------------------------------------------------------------------------------------------- | ------- |
60+
| Android | Andrei Litvin, Yunhan Wang, Yufeng Wang | [android](https://github.com/project-chip/connectedhomeip/issues?q=is%3Aopen+is%3Aissue+label%3Aandroid) | |
61+
| Darwin | Boris Zbarsky, Justin Wood | [darwin](https://github.com/project-chip/connectedhomeip/issues?q=is%3Aopen+is%3Aissue+label%3Adarwin) | |
62+
| Espressif | Hrishikesh Dhayagude | [esp32](https://github.com/project-chip/connectedhomeip/issues?q=is%3Aopen+is%3Aissue+label%3Aesp32) | |
63+
| Linux | Andrei Litvin | [linux](https://github.com/project-chip/connectedhomeip/issues?q=is%3Aopen+is%3Aissue+label%3Alinux) | |
64+
| Nordic | Lucasz Duda | [nrf](https://github.com/project-chip/connectedhomeip/issues?q=is%3Aopen+is%3Aissue+label%3Anrf) | |
65+
| NXP | Doru Gucea | [nxp](https://github.com/project-chip/connectedhomeip/issues?q=is%3Aopen+is%3Aissue+label%3Anxp) | |
66+
| Silabs/EFR32 | Jean Francois Penven, Junior Martinez | [efr32](https://github.com/project-chip/connectedhomeip/issues?q=is%3Aopen+is%3Aissue+label%3Aefr32) | |
67+
68+
## Code areas
69+
70+
The following people can be contacted about issues in specific area of code are
71+
affected that are not platform-specific.
72+
73+
| Code area | Contact | Label | Note(s) |
74+
| ------------------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
75+
| ARM cross-compile | Andrei Litvin | N/A | Some support for cross-compiling on x64 linux for arm64 linux (like Raspberry PI) |
76+
| Build system (darwin, xcode) | Boris Zbarsky, Justin Wood | N/A | darwin specific builds, xcode connector |
77+
| Build system (gn, ninja) | Andrei Litvin | N/A | General build system questions and gn support, generally on Linux |
78+
| MatterIDL | Andrei Litvin | N/A | General .matter files and code generation based on it |
79+
| Minimal MDNS | Andrei Litvin | N/A | mdns specfic. Note that platformdns also exists and issues are often "DNSSD" rather than minmdns specific |
80+
| Python testing infrastructure/helpers | Cecille Freeman | N/A | Writing tests cases in python. **NOTE** this is for test infrastrure and NOT for individual test issues. Test case failures are associated with test applications or the test case script. |
81+
| ZAP Code Generation | Boris Zbarsky, Bharat Raju Dandu | [zap](https://github.com/project-chip/connectedhomeip/issues?q=is%3Aopen+is%3Aissue+label%3Azap) | Some issues may be in the zap project itself. This is for generic code generation issues and help, often regarding `.zapt` templates |
82+
| src/crypto, src/credentials | Tennessee Carmel-Veilleux | N/A | |
83+
84+
## Example maintenance
85+
86+
Examples often correspond to specific device types. We have split the contact
87+
per device type regardless of example (e.g. all-clusters will contain all device
88+
types or functionality) as well as individual examples.
89+
90+
### Per device type
91+
92+
| Device Type(s) | Contact | Label | Note(s) |
93+
| -------------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------ | ------- |
94+
| Fabric Bridge, Fabric Sync | Yufeng Wang, Terence Hampson | [fabric-sync](https://github.com/project-chip/connectedhomeip/pulls?q=is%3Aopen+is%3Apr+label%3Afabric-sync) | |
95+
96+
### Per example
97+
98+
| Example path | Contact | Note(s) |
99+
| ---------------------------------------------- | ---------------------------- | ------------ |
100+
| `examples/air-purifier-app` | | UNMAINTAINED |
101+
| `examples/air-quality-sensor-app` | | UNMAINTAINED |
102+
| `examples/all-clusters-app` | | UNMAINTAINED |
103+
| `examples/all-clusters-minimal-app` | | UNMAINTAINED |
104+
| `examples/android` | Yunhan Wang | |
105+
| `examples/bridge-app` | | UNMAINTAINED |
106+
| `examples/build_overrides` | | UNMAINTAINED |
107+
| `examples/chef` | Andrei Litvin | |
108+
| `examples/chip-tool` | | UNMAINTAINED |
109+
| `examples/contact-sensor-app` | | UNMAINTAINED |
110+
| `examples/darwin-framework-tool` | Boris Zbarsky | |
111+
| `examples/dishwasher-app` | | UNMAINTAINED |
112+
| `examples/energy-management-app` | James Harrow | |
113+
| `examples/fabric-admin` | Yufeng Wang, Terence Hampson | |
114+
| `examples/fabric-bridge-app` | Yufeng Wang, Terence Hampson | |
115+
| `examples/java-matter-controller` | Yunhan Wang, Yufeng Wang | |
116+
| `examples/kotlin-matter-controller` | Yunhan Wang, Yufeng Wang | |
117+
| `examples/laundry-washer-app` | | UNMAINTAINED |
118+
| `examples/lighting-app` | Junior Martinez | |
119+
| `examples/lighting-app-data-mode-no-unique-id` | | UNMAINTAINED |
120+
| `examples/light-switch-app` | | UNMAINTAINED |
121+
| `examples/lit-icd-app` | Yunhan Wang | |
122+
| `examples/lock-app` | | UNMAINTAINED |
123+
| `examples/log-source-app` | | UNMAINTAINED |
124+
| `examples/microwave-oven-app` | Rob Bultman | |
125+
| `examples/minimal-mdns` | Andrei Litvin | |
126+
| `examples/network-manager-app` | Thomas Lea | |
127+
| `examples/ota-provider-app` | | UNMAINTAINED |
128+
| `examples/ota-requestor-app` | | UNMAINTAINED |
129+
| `examples/persistent-storage` | | UNMAINTAINED |
130+
| `examples/pigweed-app` | | UNMAINTAINED |
131+
| `examples/placeholder` | | UNMAINTAINED |
132+
| `examples/providers` | | UNMAINTAINED |
133+
| `examples/pump-app` | | UNMAINTAINED |
134+
| `examples/pump-controller-app` | | UNMAINTAINED |
135+
| `examples/refrigerator-app` | | UNMAINTAINED |
136+
| `examples/resource-monitoring-app` | | UNMAINTAINED |
137+
| `examples/rvc-app` | | UNMAINTAINED |
138+
| `examples/smoke-co-alarm-app` | | UNMAINTAINED |
139+
| `examples/temperature-measurement-app` | | UNMAINTAINED |
140+
| `examples/thermostat` | | UNMAINTAINED |
141+
| `examples/thread-br-app` | | UNMAINTAINED |
142+
| `examples/tv-app` | Chris DeCenzo, Lazar Kovacic | |
143+
| `examples/tv-casting-app` | Chris DeCenzo, Lazar Kovacic | |
144+
| `examples/virtual-device-app` | | UNMAINTAINED |
145+
| `examples/water-leak-detector-app` | | UNMAINTAINED |
146+
| `examples/window-app` | | UNMAINTAINED |

0 commit comments

Comments
 (0)