FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
http/.coderabbit.yaml at develop · cppalliance/http · GitHub
Uh oh!
There was an error while loading.
Please reload this page
.
cppalliance
/
http
Public
Notifications
You must be signed in to change notification settings
Fork
15
Star
36
Code
Issues
46
Pull requests
11
Actions
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Actions
Security and quality
Insights
Expand file tree
Breadcrumbs
http
/
.coderabbit.yaml
Copy path
More file actions
More file actions
Latest commit
History
History
History
75 lines (65 loc) · 2.72 KB
Breadcrumbs
http
/
.coderabbit.yaml
Copy path
File metadata and controls
75 lines (65 loc) · 2.72 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
#
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
- Docstrings are required for all classes and functions in public
headers in non-detail namespaces. Docstrings should include a brief
description of purpose, document all parameters, return values, and
any preconditions, postconditions, or exceptions. For template
parameters, document constraints or concepts required. Warn if a
class or function is missing a docstring or if the docstring fails
to cover these elements.
- Avoid redundant documentation that merely restates the obvious from
the name and signature. Docstrings should add value beyond what the
declaration already communicates. Do not warn about terse
documentation for self-explanatory accessors or trivial type aliases.
- Document thread-safety guarantees and exception specifications where
applicable, particularly for classes intended for concurrent use or
functions that may throw.
- Files containing non-trivial implementation logic should include a
`/* */` block comment after the includes that provides a high-level
overview of how the implementation works. This should highlight
anything tricky or non-obvious that a maintainer might need to know
in order to reason effectively about the code. Warn if such files
lack this overview or if the overview appears stale relative to the
code.
- Single-line `//` comments within code should be used sparingly and
judiciously, explaining the why (not the what or how) when it is
non-obvious. Warn about comments that merely restate what the code
does or excessive commenting that adds noise rather than clarity.
Back
|
FazBrowse Home
|
New Git URL