We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 3625c6d commit 144fec6Copy full SHA for 144fec6
CLAUDE.md
@@ -90,6 +90,15 @@ Always add comments for:
90
- Workarounds for external limitations
91
- Any code that would make an experienced engineer pause and wonder "why?"
92
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
102
Crate versions are always given as XX.YY and not XX.YY.ZZ.
103
104
# Testing
0 commit comments