From 198022f58d125bcc1e4c2f9e47506a29c8fa21b2 Mon Sep 17 00:00:00 2001 From: Tom Boucher Date: Thu, 30 Apr 2026 21:13:55 -0400 Subject: [PATCH] chore(ci): disable CodeRabbit docstring coverage check (#2932) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The docstring coverage pre-merge check (default: warning at 80% threshold) produces false-positive warnings on PRs whose new code is entirely test files: it counts test(...) / beforeEach / afterEach arrow-function callbacks as functions and reports 0% coverage because nothing has JSDoc. CR's documented schema for reviews.pre_merge_checks.docstrings only accepts `mode` and `threshold` — there is no per-check path filter that would let us exclude tests/** while keeping the check active elsewhere. The top-level path_filters approach would silence ALL CR review on test files (security scans, out-of-scope checks, the substantive line-level findings) which we want to keep. Disabling the check entirely is the right call for this repo because: - GSD ships a CLI + agent runtime, not a documented public library - The internal helpers that warrant JSDoc already have it - The other CR pre-merge checks (out-of-scope, security, title) are meaningful for this codebase and stay enabled Closes #2932 --- .coderabbit.yaml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .coderabbit.yaml diff --git a/.coderabbit.yaml b/.coderabbit.yaml new file mode 100644 index 000000000..a09f00ece --- /dev/null +++ b/.coderabbit.yaml @@ -0,0 +1,26 @@ +# CodeRabbit configuration — gsd-build/get-shit-done +# +# Schema: https://docs.coderabbit.ai/reference/yaml-template/ +# +# Project context: GSD ships a CLI tool + an agent runtime, not a documented +# public library. We carry rich JSDoc on internal helpers that warrant it +# (see bin/install.js, get-shit-done/bin/lib/*.cjs) but we do not enforce a +# blanket docstring coverage bar — see issue #2932 for rationale. + +reviews: + pre_merge_checks: + # Disable docstring coverage check. + # + # The check produces false-positive warnings on PRs whose new code is + # entirely test files: it counts test(...) / beforeEach / afterEach + # arrow-function callbacks as functions and then reports 0% coverage + # because nothing has JSDoc. There is no per-check path filter in CR's + # documented schema that would let us exclude tests/** while keeping + # the check active elsewhere, and the top-level path_filters approach + # would silence ALL CR review on tests (security scans, out-of-scope + # checks, line-level findings) which we want to keep. + # + # All other CR pre-merge checks (out-of-scope, security, title) remain + # at their defaults. + docstrings: + mode: off