docs: add CLAUDE.md code style notes

2026-10-15 05:11:26 +00:00 · 2026-08-27 01:15:17 -06:00
parent 63efbffcfd
commit 4710c28db5
1 changed files with 6 additions and 0 deletions
@@ -0,0 +1,6 @@
+## Code style
+- Don't write comments that restate what the code already says.
+- Comment only the "why" when something isn't obvious: workarounds,
+  counterintuitive decisions, constraints from an external API.
+- No section-divider comments like `// --- Helpers ---`.
+- Don't leave comments describing the change you just made.