Skip to content

Commit 9a283c3

Browse files
andy31415andreilitvingemini-code-assist[bot]
authored
Add support for sdk-maintainer-approved in pullapprove, update docs (project-chip#40195)
* Add pullapprove rules for SDK maintainers * Move doc lins to top of the page, for simplified reading * Re-organize documentation to group contributing together * Add PR reviews bits * Restyle, some wording updates * Update docs/contributing/index.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Add new works and resort word file * Fix links --------- Co-authored-by: Andrei Litvin <andreilitvin@google.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent bd05913 commit 9a283c3

File tree

11 files changed

+180
-31
lines changed

11 files changed

+180
-31
lines changed

.github/.wordlist.txt

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -274,8 +274,8 @@ codelabs
274274
ColorControl
275275
Combinators
276276
Comcast
277-
Commandline
278277
CommandHandlerInterface
278+
Commandline
279279
CommandName
280280
Commissionable
281281
CommissionableDataProvider
@@ -303,8 +303,8 @@ connstring
303303
conntype
304304
const
305305
ContentApp
306-
ContentApp's
307306
ContentAppPlatform
307+
ContentApp's
308308
ContentLaunch
309309
ContentLauncher
310310
contrib
@@ -472,8 +472,8 @@ DS
472472
DSLS
473473
duplicative
474474
DUT
475-
DUTS
476475
DUT's
476+
DUTS
477477
DV
478478
DVK
479479
dynload
@@ -533,10 +533,10 @@ EthernetNetworkDiagnostics
533533
ethernets
534534
EthyleneConcentrationMeasurement
535535
EthyleneOxideConcentrationMeasurement
536+
EV
536537
EvalCode
537538
EvalCodeWithName
538539
EvalFrameDefault
539-
EV
540540
EVB
541541
EventLogging
542542
evk
@@ -571,9 +571,9 @@ feff
571571
ffaa
572572
ffeebaefa
573573
FFF
574-
FFFFFFFFFFFF0102
575574
fffe
576575
fffff
576+
FFFFFFFFFFFF0102
577577
FFmpeg
578578
Fi
579579
filepath
@@ -618,13 +618,13 @@ GenericWiFiConfigurationManagerImpl
618618
GetDeviceId
619619
GetDeviceInfo
620620
GetDns
621-
getter
622-
getters
623621
GetInDevelopmentTests
624622
GetIP
625623
getManualTests
626624
GetSafeAttributePersistenceProvider
627625
getstarted
626+
getter
627+
getters
628628
GH
629629
ghcr
630630
ghp
@@ -677,9 +677,10 @@ HomePod
677677
HomePods
678678
hostapd
679679
hostname
680+
hotfixes
680681
href
681-
HSM
682682
hsm
683+
HSM
683684
HTTPS
684685
Humidistat
685686
HW
@@ -760,14 +761,14 @@ itemName
760761
iterable
761762
itsfoss
762763
IW
764+
JCM
763765
JDK
766+
jf
764767
jinja
765-
JCM
766768
JLink
767769
JLinkExe
768770
JLinkRTTClient
769771
JN
770-
jf
771772
jni
772773
jpg
773774
jre
@@ -838,6 +839,8 @@ LightingApp
838839
LightingColor
839840
LightingState
840841
LinkSoftwareAndDocumentationPack
842+
linter
843+
linters
841844
lladdr
842845
LocalConfigDisabled
843846
localedef
@@ -1235,8 +1238,8 @@ repo
12351238
repos
12361239
req
12371240
Requestor
1238-
Requestor's
12391241
RequestorCanConsent
1242+
Requestor's
12401243
Requestors
12411244
responder
12421245
RestrictedEvent
@@ -1271,8 +1274,8 @@ RTOS
12711274
RTT
12721275
RTX
12731276
runArgs
1274-
runIf
12751277
RUNAS
1278+
runIf
12761279
RunMain
12771280
runtime
12781281
RVC
@@ -1294,8 +1297,8 @@ SDB
12941297
SDC
12951298
SDHC
12961299
SDK
1297-
SDK's
12981300
sdkconfig
1301+
SDK's
12991302
SDKs
13001303
SDKTARGETSYSROOT
13011304
sdl
@@ -1422,6 +1425,7 @@ sysv
14221425
TargetNavigator
14231426
TBD
14241427
tbody
1428+
TBR
14251429
tcl
14261430
TCP
14271431
teardown
@@ -1498,8 +1502,8 @@ triaged
14981502
triaging
14991503
TriggerEffect
15001504
TRNG
1501-
trustm
15021505
TrustedRootCertificates
1506+
trustm
15031507
tsan
15041508
TSG
15051509
tsv
@@ -1531,6 +1535,7 @@ Ultrafast
15311535
UNBLUR
15321536
uncommissioned
15331537
Unencrypted
1538+
unfixable
15341539
unfocus
15351540
Unicast
15361541
UniFlash
@@ -1564,8 +1569,8 @@ util
15641569
utils
15651570
UUID
15661571
ux
1567-
validator
15681572
valgrind
1573+
validator
15691574
vcom
15701575
VCP
15711576
Vectorcall
@@ -1678,4 +1683,3 @@ Zigbee
16781683
zigbeealliance
16791684
zigbeethread
16801685
zsdk
1681-
TBR

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
If fixing an error, explain the root cause and the chosen solution's rationale, especially if not obvious.
77
Include context like links to related documents/issues/test plans and highlight notable information or specific concerns.
88
9-
See guidelines: https://project-chip.github.io/connectedhomeip-doc/pull_request_guidelines.html#pr-summary-description
10-
See title formatting: https://project-chip.github.io/connectedhomeip-doc/pull_request_guidelines.html#title-formatting
9+
See guidelines: https://project-chip.github.io/connectedhomeip-doc/contributing/pull_request_guidelines.html#pr-summary-description
10+
See title formatting: https://project-chip.github.io/connectedhomeip-doc/contributing/pull_request_guidelines.html#title-formatting
1111
1212
Please replace this HTML comment with the actual PR summary.
1313
-->
@@ -35,7 +35,7 @@
3535
As a general rule, a proposed PR change must not break the existing code and must be well-tested.
3636
Please include information about testing.
3737
38-
See testing guidelines: https://project-chip.github.io/connectedhomeip-doc/pull_request_guidelines.html#testing
38+
See testing guidelines: https://project-chip.github.io/connectedhomeip-doc/contributing/pull_request_guidelines.html#testing
3939
4040
Examples:
4141
added unit tests
@@ -52,12 +52,12 @@ The checklist below will help the reviewer finish PR review in time and keep the
5252
code readable:
5353

5454
- [ ] PR title is
55-
[descriptive](https://project-chip.github.io/connectedhomeip-doc/pull_request_guidelines.html#title-formatting)
55+
[descriptive](https://project-chip.github.io/connectedhomeip-doc/contributing/pull_request_guidelines.html#title-formatting)
5656
- [ ] Apply the
5757
[_“When in Rome…”_](https://project-chip.github.io/connectedhomeip-doc/style/CODING_STYLE_GUIDE.html)
5858
rule (coding style)
5959
- [ ] PR size is short
6060
- [ ] Try to avoid "squashing" and "force-update" in commit history
6161
- [ ] CI time didn't increase
6262

63-
See: [Pull Request Guidelines](https://project-chip.github.io/connectedhomeip-doc/pull_request_guidelines.html)
63+
See: [Pull Request Guidelines](https://project-chip.github.io/connectedhomeip-doc/contributing/pull_request_guidelines.html)

.pullapprove.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,13 @@ overrides:
4848
status: success
4949
explanation: "PR has been fast tracked, bypassing reviews"
5050

51+
############################################################
52+
# Approved by matter-sdk-maintainers
53+
############################################################
54+
- if: "'sdk-maintainers-approved' in labels and len(groups.approved.include('sdk-maintainers')) >= 1"
55+
status: success
56+
explanation: "Approved by SDK maintainer and label is set."
57+
5158
############################################################
5259
# Notifications
5360
############################################################
@@ -253,6 +260,15 @@ groups:
253260
reviews:
254261
request: 0 # Do not auto-add
255262

263+
sdk-maintainers:
264+
type: optional
265+
conditions:
266+
- files.include('*')
267+
reviewers:
268+
teams: [matter-sdk-maintainers]
269+
reviews:
270+
request: 0 # Do not auto-add
271+
256272
############################################################
257273
# Folder specific review requirements. A PR must meet all
258274
# folder specific review requirements for all folders that

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ Aim to make pull requests easy to read both when viewed in a list (title only)
166166
as well as clear in content within the description.
167167

168168
Pull request guidelines described in detail
169-
[here](./docs/pull_request_guidelines.md)
169+
[here](./docs/contributing/pull_request_guidelines.md)
170170

171171
### Review Requirements
172172

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# Documentation links
2+
3+
- [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/project-chip/connectedhomeip)
4+
- [Matter SDK documentation page](https://project-chip.github.io/connectedhomeip-doc/index.html)
5+
- [Matter SDK Coverage Report](https://matter-build-automation.ue.r.appspot.com/)
6+
17
# Matter
28

39
[![Builds](https://github.com/project-chip/connectedhomeip/workflows/Builds/badge.svg)](https://github.com/project-chip/connectedhomeip/actions/workflows/build.yaml)
@@ -34,18 +40,13 @@
3440
[![Cirque](https://github.com/project-chip/connectedhomeip/workflows/Cirque/badge.svg)](https://github.com/project-chip/connectedhomeip/actions/workflows/cirque.yaml)
3541
[![QEMU](https://github.com/project-chip/connectedhomeip/workflows/QEMU/badge.svg)](https://github.com/project-chip/connectedhomeip/actions/workflows/qemu.yaml)
3642

37-
- [Matter SDK Coverage Report](https://matter-build-automation.ue.r.appspot.com/)
38-
3943
**Tools**
4044

4145
[![ZAP Templates](https://github.com/project-chip/connectedhomeip/workflows/ZAP/badge.svg)](https://github.com/project-chip/connectedhomeip/actions/workflows/zap_templates.yaml)
4246

4347
**Documentation**
4448

4549
[![Documentation Build](https://github.com/project-chip/connectedhomeip/actions/workflows/docbuild.yaml/badge.svg)](https://github.com/project-chip/connectedhomeip/actions/workflows/docbuild.yaml)
46-
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/project-chip/connectedhomeip)
47-
48-
- [Matter SDK documentation page](https://project-chip.github.io/connectedhomeip-doc/index.html)
4950

5051
# About
5152

docs/PROJECT_FLOW.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ base. They should be easy to review, as a "yes, that's better". Refrain from
2828
requesting review until all PR checks have completed successfully, lest you tire
2929
your reviewers.
3030

31-
See a guideline [here](./pull_request_guidelines.md)
31+
See a guideline [here](./contributing/pull_request_guidelines.md)
3232

3333
### Milestones
3434

File renamed without changes.

docs/contributing/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing to matter
2+
3+
The following docs present information about contributing to matter: how to
4+
create quality bug reports, how to organize pull requests and how pull requests
5+
are reviewed.
6+
7+
```{toctree}
8+
:glob:
9+
:maxdepth: 1
10+
:hidden:
11+
12+
*
13+
14+
```
15+
16+
- [Reporting bugs](./BUG_REPORT.md)
17+
- [Pull request guidelines](./pull_request_guidelines.md)

0 commit comments

Comments
 (0)