summaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-17 12:35:51 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-17 12:35:51 +0300
commit772c2fe621b645c4a66f3808639fd06e2bdf6f84 (patch)
tree5de0691d93878714cc5a2be4489892dc9d131804 /AGENTS.md
parent5899daca821dc97cf7b77e6e3963e41b0245ac17 (diff)
downloadcoderabbit-772c2fe621b645c4a66f3808639fd06e2bdf6f84.tar.gz
coderabbit-772c2fe621b645c4a66f3808639fd06e2bdf6f84.zip
T8595: clarify inheritance: true behavior in AGENTS.md
Address CodeRabbit L5 finding (PR #4) — the original wording could be read as saying inheritance: true causes consumers to be excluded from the central baseline, when in fact it enables deep-merge with the baseline. Rewrite to state the merge contract explicitly. 🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/AGENTS.md b/AGENTS.md
index 9af2473..682024e 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -2,7 +2,7 @@
## Project purpose
-Central [CodeRabbit](https://www.coderabbit.ai/) configuration baseline for the `vyos` (public) GitHub organisation. `.coderabbit.yaml` here is applied to every `vyos/<repo>` PR review unless the consumer carries its own `.coderabbit.yaml` with `inheritance: true`. Discovery is name-load-bearing — CodeRabbit's [central-configuration](https://docs.coderabbit.ai/configuration/central-configuration) feature looks up the literal repo name `coderabbit` in each org; renaming breaks the integration.
+Central [CodeRabbit](https://www.coderabbit.ai/) configuration baseline for the `vyos` (public) GitHub organisation. `.coderabbit.yaml` here is applied to every `vyos/<repo>` PR review by default. Per-repo overrides MUST pin `inheritance: true` to merge with this baseline (deep-merge: objects merge, arrays union, scalars child-wins); a per-repo file without `inheritance: true` fully replaces this baseline instead. Discovery is name-load-bearing — CodeRabbit's [central-configuration](https://docs.coderabbit.ai/configuration/central-configuration) feature looks up the literal repo name `coderabbit` in each org; renaming breaks the integration.
Sibling — **not** twin — of [VyOS-Networks/coderabbit](https://github.com/VyOS-Networks/coderabbit). Several intentional divergences (see "Cross-repo context"); never blindly mirror changes across.