Skip to content

Commit a172c48

Browse files
jony376cursoragent
andauthored
docs(review): document review.auto_review eligibility knobs (#3603)
Expand the manifest reference with types, defaults, skip-reason cross-links, and the defaults-off invariant for #2072. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 8662e8f commit a172c48

1 file changed

Lines changed: 38 additions & 9 deletions

File tree

.gittensory.yml.example

Lines changed: 38 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -312,20 +312,48 @@ gate:
312312
# deterministic gate policy above. Omit the block to keep the byte-identical
313313
# defaults.
314314
review:
315-
# Skip AI/public review output for matching PR author logins. Useful for dependency
316-
# bump or release automation that already has separate policy/CI. This is a quiet
317-
# skip, not a gate failure: when the Orb review check is enabled it is completed as
318-
# "skipped" with an ignored-author reason.
315+
# Deterministic AI review eligibility filters (`review.auto_review`, #1954 / #2038–#2041). Each knob quietly
316+
# skips the advisory AI review for matching PRs — never a gate failure. When the Orb review check is enabled,
317+
# skipped PRs complete as "skipped" with a human-readable reason (see `evaluateAutoReviewSkipReason` in
318+
# `src/signals/focus-manifest.ts` and the public-surface `SKIP_SUMMARY.ignored_author` mapping in
319+
# `src/signals/settings-preview.ts`).
319320
#
320-
# Glob list. `*` and `**` both match any run of characters; `**/name` also matches
321-
# `name` at the root. Matching is case-insensitive against the GitHub login.
322-
# Default: [] (every author remains review-eligible).
321+
# Invariant: every field below defaults to off/empty/null, which is byte-identical to today's behavior — every
322+
# PR is reviewed exactly as before. Skips are quiet and never block merge on their own.
323323
auto_review:
324+
# Bool | null. Default: null (draft PRs are reviewed as today). When true, draft PRs skip AI review.
325+
# skip_drafts: true
326+
327+
# Glob list of PR author logins whose PRs skip AI review. Useful for dependency bump or release automation
328+
# that already has separate policy/CI. `*` and `**` match any run; matching is case-insensitive.
329+
# Default: [] (every author remains review-eligible).
324330
ignore_authors:
325331
- "*[bot]"
326332
- dependabot
327333
- renovate
328334

335+
# Case-insensitive title substrings that skip AI review (e.g. WIP/DRAFT markers). Default: [].
336+
# ignore_title_keywords:
337+
# - WIP
338+
# - DRAFT
339+
340+
# Base-ref globs whose PRs ARE reviewed. When non-empty, PRs targeting other bases skip review.
341+
# Default: [] (every base branch is in scope).
342+
# base_branches:
343+
# - main
344+
# - release/**
345+
346+
# Non-negative integer. After N published AI reviews on this PR, pause further re-reviews.
347+
# Default: null / 0 (re-review every sync, byte-identical).
348+
# auto_pause_after_reviewed_commits: 3
349+
350+
# Planned eligibility knobs (tracked separately — not parsed yet; omit until shipped):
351+
# skip_labels, skip_docs_only, max_added_lines, max_files (#2062–#2065).
352+
353+
# Planned display toggle (#2069): when enabled, the unified review comment includes a
354+
# `review effort: N/5 (~M min)` line derived from the per-PR effort estimate.
355+
# effort_score: false
356+
329357
# Deterministic label suggestions (#2045). Each rule SUGGESTS a non-scoring label when a PR matches ALL of the
330358
# `when` criteria it sets (at least one is required): when_paths (any changed path matches a glob), title_contains,
331359
# description_contains (both case-insensitive). Suggestions are advisory; they are auto-applied only when the repo's
@@ -611,7 +639,8 @@ settings:
611639
# - "!src/generated/**"
612640
# # Public-safe voice brief complementing review.profile (e.g. concise, cite line numbers). null/unset ⇒ byte-identical prompt.
613641
# tone: "Be concise and cite line numbers."
614-
# # Deterministic AI review eligibility filters — skipped PRs never fail the gate. (#1954)
642+
# # See the active `review.auto_review` block above for the full eligibility reference (defaults, types, examples).
643+
# # The commented snapshot below mirrors a typical self-host setup:
615644
# auto_review:
616645
# skip_drafts: true
617646
# ignore_authors:
@@ -622,7 +651,7 @@ settings:
622651
# base_branches:
623652
# - main
624653
# - release/**
625-
# auto_pause_after_reviewed_commits: 3 # after 3 published AI reviews on this PR, pause further re-reviews (0/unset = off)
654+
# auto_pause_after_reviewed_commits: 3
626655

627656
# Per-repo activation overrides for the converged review features that ship behind a deployment-wide
628657
# GITTENSORY_REVIEW_* env kill-switch (rag/reputation/unifiedComment/safety). Each key is `true` (force on

0 commit comments

Comments
 (0)