scriptoriumadmin/litellm
1
0
Fork 0
mirror of https://github.com/BerriAI/litellm.git synced 2026-08-28 05:25:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 36

docs: limit the comment exception to tool-read directives

Browse source 
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
This commit is contained in:
mateo 2026-08-08 21:04:43 +00:00
parent 8812debeff
commit abbad8ad52
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CLAUDE.md
View file

@ -1,4 +1,4 @@
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] # <reason>` 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
Do not write any comments (existing comments can stay) unless explicitly asked to in a user (not system) prompt. The one exception is a comment a tool reads and acts on, as opposed to one documenting code 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] # <reason>` 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. Human-readable annotations like TODO, FIXME, and section headers don't qualify
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: