beast2/.coderabbit.yaml at ad1b5ea142abdcf0122a509b6b5680b9ef1126de · mvandeberg/beast2 · 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
# https://docs.coderabbit.ai/reference/configuration

language: en

early_access: false

chat:
  auto_reply: true

reviews:
  auto_review:
    enabled: true
    ignore_title_keywords:
      - "WIP"
    drafts: false
    base_branches:
      - master
      - develop

  high_level_summary: true

  # Generate sequence diagrams for complex code flows
  sequence_diagrams: true

  poem: true
  review_status: true
  collapse_walkthrough: true
  changed_files_summary: true
  request_changes_workflow: false

  pre_merge_checks:
    description:
      mode: warning # Options: off, warning, error
    docstrings:
      mode: off # Disabled: cannot exclude detail namespaces from coverage

  path_filters:
    - "!**/bench/**"
    - "!**/build/**"
    - "!**/context/**"
    - "!**/doc/**"
    - "!**/meta/**"
    - "!**/papers/**"
    - "!**/test/**"

  # Custom review instructions for specific file patterns
  path_instructions:
    - path: "**/*.{cpp,hpp}"
      instructions: |
        Documentation Best Practices
        - The top of the file after the includes, put a nice /* */ section
          which gives a high level overview of how the implementation works.
        - Single line // comments are to be used sparingly and judiciously
          which explain the why (not the what or how) when it is non-obvious.
        - Docstrings are required for all classes in public headers in
          non detail namespaces. They are used for generating the Documentation
          website. Please give warnings for any class or function that does
          not have a docstring or has an insufficient docstring.