mentoring/coderabbit.yaml at master · ELEVATE-Project/mentoring · 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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# yaml-language-server: $schema=https://storage.googleapis.com/coderabbit_public_assets/schema.v2.json

language: en-US
tone_instructions: ''
early_access: false
enable_free_tier: true
reviews:
  profile: chill
  request_changes_workflow: false
  high_level_summary: true
  high_level_summary_placeholder: '@coderabbitai summary'
  high_level_summary_in_walkthrough: false
  auto_title_placeholder: '@coderabbitai'
  auto_title_instructions: ''
  review_status: false
  full_review: true
  commit_status: true
  fail_commit_status: false
  collapse_walkthrough: false
  changed_files_summary: true
  sequence_diagrams: true
  estimate_code_review_effort: true
  assess_linked_issues: true
  related_issues: true
  related_prs: true
  suggested_labels: true
  auto_apply_labels: false
  suggested_reviewers: true
  auto_assign_reviewers: false
  poem: true
  labeling_instructions: []
  base_branches: # allow auto-reviews on these target branches
    - master
    - develop
    - staging
    - feature/*

  #Exclude non-source code directories from reviews.
  path_filters:
    - '!deployment/**'
    - '!dev-ops/**'
    - '!release-notes/**'
    - '!src/api-doc/**'
    - '!src/assets/**'
    - '!src/configs/**'
    - '!src/public/**'
    - '!src/temp/**'
    - '!**/*.md'

  # Add specific review instructions for critical paths.
  path_instructions:
    - path: 'src/services/**'
      instructions: 'This is core business logic. Please check for correctness, efficiency, and potential edge cases.'
    - path: 'src/controllers/**'
      instructions: 'These are API controllers. Focus on request/response handling, security (auth middleware usage), and proper status codes.'
    - path: 'src/database/queries/**'
      instructions: 'Review database queries for performance. Check for N+1 problems and ensure indexes can be used.'
    - path: 'src/validators/**'
      instructions: 'Validate all incoming data thoroughly. Check for missing or incomplete validation rules.'
    - path: 'src/middlewares/**'
      instructions: 'This is security-sensitive middleware. Scrutinize for potential vulnerabilities.'

  abort_on_close: true
  disable_cache: false
  auto_review:
    enabled: true
    auto_incremental_review: true
    ignore_title_keywords: ['WIP', 'skip-review']
    labels: []
    drafts: false
    # Target reviews to development branches.
    base_branches:
      - 'develop'

  finishing_touches:
    docstrings:
      enabled: true
    unit_tests:
      enabled: true
  pre_merge_checks:
    docstrings:
      mode: warning
      threshold: 80
    title:
      mode: warning
      requirements: ''
    description:
      mode: warning
    issue_assessment:
      mode: warning
  tools:
    eslint:
      enabled: true
    semgrep:
      enabled: true
    dotenvLint:
      enabled: true
    sqlfluff:
      enabled: true
    checkov:
      enabled: true
    gitleaks:
      enabled: true
    hadolint:
      enabled: true
    shellcheck:
      enabled: true
    actionlint:
      enabled: true
    circleci:
      enabled: true
    github-checks:
      enabled: true
    markdownlint:
      enabled: true
    yamllint:
      enabled: true
    biome:
      enabled: true
    languagetool:
      enabled: false # optional
    ast-grep:
      essential_rules: true
      rule_dirs: []
      util_dirs: []
      packages: []
chat:
  auto_reply: true
  integrations:
    jira:
      usage: auto
    linear:
      usage: auto
knowledge_base:
  opt_out: false
  web_search:
    enabled: true
  code_guidelines:
    enabled: true
    filePatterns: []
  learnings:
    scope: auto
  issues:
    scope: auto
  jira:
    usage: auto
    project_keys: []
  linear:
    usage: auto
    team_keys: []
  pull_requests:
    scope: auto
code_generation:
  docstrings:
    language: en-US
    path_instructions: []
  unit_tests:
    path_instructions: []