Skip to content

Commit 144fec6

Browse files
committed
CLAUDE.md update
Signed-off-by: Brian L. Troutwine <brian.troutwine@datadoghq.com>
1 parent 3625c6d commit 144fec6

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CLAUDE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,15 @@ Always add comments for:
9090
- Workarounds for external limitations
9191
- Any code that would make an experienced engineer pause and wonder "why?"
9292

93+
NEVER write comments that state the obvious like:
94+
- "Create a handle for each connection" when the code says `let handle = block_cache.handle()`
95+
- "Loop through connections" before a for loop
96+
- "Check if condition" before an if statement
97+
- "Return the result" before a return statement
98+
99+
If the code is self-documenting, DO NOT add a comment. Comments should provide
100+
insight that cannot be gleaned from reading the code itself.
101+
93102
Crate versions are always given as XX.YY and not XX.YY.ZZ.
94103

95104
# Testing

0 commit comments

Comments
 (0)