agents.md: keep comments to a reasonable level (#4716)

2026-10-12 02:12:31 +00:00 · 2026-09-29 11:51:39 +02:00
parent 6040911b8d
commit 3897387ad2
1 changed files with 2 additions and 1 deletions
@@ -96,7 +96,8 @@ Write:
 > source that goes silent — connection now drops after 30s instead of hanging.

 **Code comments** — explain why, not what. If the comment restates the line under it, delete
-it.
+it. Keep them short and to the point, not prose: a comment should rarely be longer than the code
+it describes. A 20-line comment over a 5-line function is noise.

 **Review replies** — answer the question that was asked. Don't re-explain the PR, and don't
 paste your agent's output into the thread. Read it, then reply in your own words, in a few