orchestrator/.coderabbit.yaml at main · BoardKit/orchestrator · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

language: "en-US"
tone_instructions: "Be concise. Focus on actionable issues—broken paths, invalid JSON, shell bugs. Skip style nitpicks on markdown."
early_access: false

reviews:
  profile: "chill"
  request_changes_workflow: false
  high_level_summary: true
  review_status: true
  collapse_walkthrough: false
  poem: false
  sequence_diagrams: true
  estimate_code_review_effort: true
  suggested_labels: true
  auto_apply_labels: false
  suggested_reviewers: false

  auto_review:
    enabled: true
    auto_incremental_review: true
    auto_pause_after_reviewed_commits: 5
    ignore_title_keywords:
      - "WIP"
      - "DO NOT MERGE"
      - "draft"
    drafts: false

  path_filters:
    - "!**/node_modules/**"
    - "!**/*.lock"
    - "!**/package-lock.json"
    - "!dev/active/**"
    - "!doc-sync-logs/**"

  path_instructions:
    - path: "shared/agents/**/*.md"
      instructions: |
        Agent definition files for Claude Code. Check:
        - YAML frontmatter has required fields: name, description, model
        - Description is a SINGLE LINE with \n escapes (no actual newlines)
        - Referenced file paths match the repo structure (shared/guidelines/*, etc.)
        - No broken cross-references to guidelines or skills
        - No product-specific content (this is a generic OSS orchestrator)

    - path: "shared/copilot-agents/**/*.agent.md"
      instructions: |
        GitHub Copilot agent files. Check:
        - YAML frontmatter has name and description fields
        - Instructions are practical and implementation-ready
        - No product-specific content

    - path: "**/*.md"
      instructions: |
        Documentation/infrastructure repo. For markdown:
        - CLI command examples should be syntactically correct
        - File paths mentioned should match the repo structure
        - Heading levels should not be skipped
        - Code blocks should have a language tag

    - path: "shared/hooks/**/*.sh"
      instructions: |
        Claude Code hook scripts that run automatically on every prompt or tool use.
        Critical: these must NEVER crash or block the user.
        - Should NOT use set -e (hooks must always exit 0)
        - All variables must be properly quoted
        - Must always exit 0 regardless of errors
        - Check jq usage if parsing JSON
        - Verify file path assumptions

    - path: "shared/hooks/**/*.ts"
      instructions: |
        TypeScript hook code executed via tsx.
        - No use of 'any' type
        - Proper error handling with typed catch blocks
        - Edge cases in file path handling
        - Must handle missing files/dirs gracefully (hooks can't crash)

    - path: "shared/skills/skill-rules.json"
      instructions: |
        Critical config controlling skill activation.
        - JSON must be valid
        - Glob patterns in file_patterns must be syntactically correct
        - No duplicate skill names
        - Version field should match skill system version

    - path: "shared/settings/**/*.json"
      instructions: |
        Claude Code settings files.
        - JSON must be valid
        - Hook command paths must reference correct script locations
        - Permission patterns must be valid Claude Code permission syntax

    - path: "setup/**"
      instructions: |
        Setup wizard scripts. Check:
        - Shell scripts are portable (POSIX where possible)
        - File operations handle spaces in paths
        - Symlink creation is correct for the documented structure

  tools:
    shellcheck:
      enabled: true
    markdownlint:
      enabled: true
    yamllint:
      enabled: true
    gitleaks:
      enabled: true
    trivy:
      enabled: true
    ruff:
      enabled: false
    pylint:
      enabled: false
    golangci-lint:
      enabled: false

  finishing_touches:
    docstrings:
      enabled: false
    unit_tests:
      enabled: false

chat:
  auto_reply: true

knowledge_base:
  opt_out: false
  web_search:
    enabled: true
  code_guidelines:
    enabled: true
    filePatterns:
      - "shared/guidelines/global/**/*.md"
      - "shared/guidelines/orchestrator/**/*.md"
      - "CLAUDE.md"
  learnings:
    scope: "local"
  issues:
    scope: "local"