.github/.coderabbit.yaml at master · InvoicePlane/.github · 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
# =======================================================
#  CodeRabbit AI Review Configuration
#  For Laravel + JS projects
#  Reference: https://docs.coderabbit.ai/config
# =======================================================

language: en-US

reviews:
  # Review tone — defines style of feedback
  # Options: assertive | chill | friendly | strict | concise | detailed
  profile: assertive

  # Require resolution before merge
  request_changes_workflow: true

  # Include an AI summary of the PR
  high_level_summary: false

  # Report check status to GitHub UI
  review_status: false
  commit_status: false
  fail_commit_status: false

  # --- collapsible: UI / Fun / Optional ------------------------------------------------
  collapse_walkthrough: false
  sequence_diagrams: false
  estimate_code_review_effort: true
  in_progress_fortune: false
  poem: false
  # ------------------------------------------------------------------------------------

  auto_review:
    enabled: false
    auto_incremental_review: true
    # --- collapsible: customization ----------------------------------------------------
    ignore_title_keywords: ['WIP', 'draft']
    labels: ['needs-review']
    drafts: false
    base_branches: ['master', 'development']
    ignore_usernames: ['dependabot', 'renovate']
    # ------------------------------------------------------------------------------------

  # --- collapsible: doc/test auto-suggestions ------------------------------------------
  finishing_touches:
    docstrings:
      enabled: false
    unit_tests:
      enabled: false
  # ------------------------------------------------------------------------------------

  # --- collapsible: pre-merge quality gates --------------------------------------------
  pre_merge_checks:
    docstrings:
      mode: warning
      threshold: 80
    title:
      mode: warning
      requirements: 'Descriptive, mentions component or ticket'
    description:
      mode: warning
  # ------------------------------------------------------------------------------------

tools:
  # --- Core linters for Laravel (PHP) and JS -------------------------------------------
  phpstan:
    enabled: true
    level: "3"
  phpcs:
    enabled: true
  eslint:
    enabled: true
  markdownlint:
    enabled: true

  # --- collapsible: supporting & infra tools -------------------------------------------
  shellcheck:
    enabled: false
  hadolint:
    enabled: false
  yamllint:
    enabled: false
  dotenvLint:
    enabled: false
  htmlhint:
    enabled: false
  semgrep:
    enabled: false
  gitleaks:
    enabled: false
  osvScanner:
    enabled: false
  actionlint:
    enabled: true
  # ------------------------------------------------------------------------------------

chat:
  # --- collapsible: personality + integrations -----------------------------------------
  art: false
  auto_reply: true
  integrations:
    jira:
      usage: disabled
    linear:
      usage: disabled
  # ------------------------------------------------------------------------------------

# --- collapsible: AI learning + docs integration ---------------------------------------
knowledge_base:
  opt_out: true
  web_search:
    enabled: false
  code_guidelines:
    enabled: false
    filePatterns: ['CONTRIBUTING.md', 'docs/code-guidelines.md']
  learnings:
    scope: global
  issues:
    scope: global
  pull_requests:
    scope: global
# ---------------------------------------------------------------------------------------

# --- collapsible: AI code generation suggestions ---------------------------------------
code_generation:
  docstrings:
    language: en-US

  unit_tests:
    # Instructions for AI-generated unit tests
    path_instructions:
      - path: 'tests/Unit/**'
        instructions: |
          Each test method must begin with `it_`.
          Annotate each test method with `#[Test]`.
          Each test method must contain `$this->markTestIncomplete();` by default.
          Prefer Fakes and Fixtures over Mocks.
          Structure tests with `it_` functions and place happy paths last.
          Reusable logic (e.g., fixtures) must reside in an abstract test case.
      - path: 'tests/Feature/**'
        instructions: |
          Each test method must begin with `it_`.
          Annotate each test method with `#[Test]`.
          Default to `$this->markTestIncomplete();` until test logic is finalized.
          Use Laravel’s HTTP helpers (`->postJson()`, `->getJson()`, etc.).
          Avoid inline fixture setup; use factories and seeders.
# ---------------------------------------------------------------------------------------