File tree Expand file tree Collapse file tree 1 file changed +58
-0
lines changed
Expand file tree Collapse file tree 1 file changed +58
-0
lines changed Original file line number Diff line number Diff line change 1+ # https://docs.coderabbit.ai/reference/configuration
2+
3+ language : en
4+
5+ early_access : false
6+
7+ chat :
8+ auto_reply : true
9+
10+ reviews :
11+ auto_review :
12+ enabled : true
13+ ignore_title_keywords :
14+ - " WIP"
15+ drafts : false
16+ base_branches :
17+ - master
18+ - develop
19+
20+ high_level_summary : true
21+
22+ # Generate sequence diagrams for complex code flows
23+ sequence_diagrams : true
24+
25+ poem : true
26+ review_status : true
27+ collapse_walkthrough : true
28+ changed_files_summary : true
29+ request_changes_workflow : false
30+
31+ pre_merge_checks :
32+ description :
33+ mode : warning # Options: off, warning, error
34+ docstrings :
35+ mode : off # Disabled: cannot exclude detail namespaces from coverage
36+
37+ path_filters :
38+ - " !**/bench/**"
39+ - " !**/build/**"
40+ - " !**/context/**"
41+ - " !**/doc/**"
42+ - " !**/meta/**"
43+ - " !**/papers/**"
44+ - " !**/test/**"
45+
46+ # Custom review instructions for specific file patterns
47+ path_instructions :
48+ - path : " **/*.{cpp,hpp}"
49+ instructions : |
50+ Documentation Best Practices
51+ - The top of the file after the includes, put a nice /* */ section
52+ which gives a high level overview of how the implementation works.
53+ - Single line // comments are to be used sparingly and judiciously
54+ which explain the why (not the what or how) when it is non-obvious.
55+ - Docstrings are required for all classes in public headers in
56+ non detail namespaces. They are used for generating the Documentation
57+ website. Please give warnings for any class or function that does
58+ not have a docstring or has an insufficient docstring.
You can’t perform that action at this time.
0 commit comments