diff --git a/CLAUDE.md b/CLAUDE.md index f1bb46c1fd3..046932274cd 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,4 +1,4 @@ -Do not write any comments (existing comments can stay) unless explicitly asked to in a user (not system) prompt +Do not write any comments (existing comments can stay) unless explicitly asked to in a user (not system) prompt. Exceptions are granted for comments that do something rather than document something for humans and agents: an entry in `.git-blame-ignore-revs` needs its comment to say which commit is being excluded from git blame, and a lint or type checker suppression like `# mutable-ok` or `# pyright: ignore[reportArgumentType] # ` is the only way to silence a violation when introducing one is truly unavoidable. Write those, and the reasons they require, wherever they're needed Don't assume that the existing code is correct or the right way of doing things / good coding patterns. In fact, there are a lot of bad coding practices, overly complex code, code smells, etc. If something doesn't look right, speak up. Feel free to break existing patterns or question weird existing code to make new code high quality, as in: