Skip to content

Commit 134923e

Browse files
zoomote[bot]roomoteedelauna
authored
[Chore] Refine CodeRabbit review checks (Zoo-Code-Org#1571)
* chore: refine CodeRabbit checks * chore: address review feedback and add coverage instructions from Zoo-Code-Org#1497 --------- Co-authored-by: Roomote <[email protected]> Co-authored-by: Elliott de Launay <[email protected]>
1 parent bb6e254 commit 134923e

1 file changed

Lines changed: 44 additions & 6 deletions

File tree

‎.coderabbit.yaml‎

Lines changed: 44 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ chat:
1111
knowledge_base:
1212
web_search:
1313
enabled: true
14+
learnings:
15+
scope: local
1416

1517
reviews:
1618
profile: assertive
@@ -61,6 +63,8 @@ reviews:
6163
cancellation, retry, and compatibility paths. Verify promises and errors are handled,
6264
existing helpers are reused, and new code introduces no `any`, unjustified double
6365
assertions, floating promises, duplicated helpers, or increased lint suppressions.
66+
When a refactor adds early-return guards that redirect a subset of inputs to a new
67+
code path, confirm the old branches for those inputs are removed or unreachable.
6468
6569
- path: "{**/*.{test,spec}.{ts,tsx,js,jsx},**/__tests__/**}"
6670
instructions: >-
@@ -76,6 +80,11 @@ reviews:
7680
Flag tests that assert in-flight behavior only after the call completes — these cannot
7781
prove the behavior fires during execution. Check that describe block names match the
7882
actual subjects of the tests they contain.
83+
For tests that assert only mock call counts, confirm a corresponding return-value
84+
assertion exists; a regression that silently returns stale fallback data can satisfy
85+
a call-count check. For code with fallback behavior, verify both the cold-start case
86+
(no prior state) and the warm case (prior state exists) are covered, as they exercise
87+
different branches.
7988
8089
- path: "apps/vscode-e2e/**"
8190
instructions: >-
@@ -115,6 +124,9 @@ reviews:
115124
Check persistence and lifecycle invariants: awaited atomic writes, rollback or explicit
116125
partial-failure behavior, cross-window state consistency, stale listeners/watchers,
117126
cancellation, idempotency, and safe restart/resume without lost or duplicated state.
127+
For async functions that read shared mutable state before an `await` and write it back
128+
after, verify the captured reference is still valid when the write executes; a concurrent
129+
mutation during the await can cause a stale snapshot to overwrite a newer state.
118130
119131
- path: ".github/**"
120132
instructions: >-
@@ -128,8 +140,20 @@ reviews:
128140
during release preparation. Verify documentation describes real behavior and contracts,
129141
and deprioritize prose-only nits that do not affect correctness or usability.
130142
143+
finishing_touches:
144+
docstrings:
145+
enabled: false
146+
131147
pre_merge_checks:
132148
override_requested_reviewers_only: true
149+
docstrings:
150+
mode: off
151+
title:
152+
mode: warning
153+
description:
154+
mode: warning
155+
issue_assessment:
156+
mode: warning
133157
custom_checks:
134158
- name: Regression evidence
135159
mode: warning
@@ -140,18 +164,32 @@ reviews:
140164
snapshot. Do not demand tests for unchanged behavior, mechanical configuration, or every
141165
branch without a plausible regression scenario. Cite the changed behavior and missing
142166
evidence.
143-
- name: Trust and persistence invariants
167+
- name: Security boundaries
168+
mode: error
169+
instructions: >-
170+
Fail only when a concrete changed path leaks secrets or PII, trusts or executes
171+
unvalidated input, or bypasses approval or allowlist controls. Cite the changed path
172+
and a plausible triggering scenario; pass when no such changed path exists.
173+
- name: Persistence integrity
144174
mode: error
145175
instructions: >-
146-
Fail only for a concrete changed path that leaks secrets or PII, trusts or executes
147-
unvalidated input, bypasses approval or allowlist controls, can lose persisted state due
148-
to a missing await, non-atomic write, or omitted default propagation, or leaks lifecycle
149-
resources. Cite the path and a plausible triggering scenario; pass when no such changed
150-
path exists.
176+
Fail only when a concrete changed persistence path can lose or corrupt state because an
177+
operation is not awaited, a write is non-atomic, rollback or explicit partial-failure
178+
behavior is missing, or a persisted default is not propagated to a consumer. Cite the
179+
changed path and a plausible triggering scenario; pass when no such changed path exists.
180+
- name: Lifecycle resource cleanup
181+
mode: error
182+
instructions: >-
183+
Fail only when a concrete changed lifecycle path can leak a listener, watcher, provider,
184+
timer, task, or other resource, or can duplicate work after cancellation, disposal, or
185+
restart. Cite the changed path and a plausible triggering scenario; pass when no such
186+
changed path exists.
151187
152188
tools:
153189
eslint:
154190
enabled: true
191+
github-checks:
192+
enabled: true
155193
actionlint:
156194
enabled: true
157195
shellcheck:

0 commit comments

Comments
 (0)