Skip to content

promote(org): comments-explain-why #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
voidhrithik merged 1 commit into from
Jul 21, 2026
Merged

promote(org): comments-explain-why #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions entries/org/comments-explain-why.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
description: Never write a comment explaining what the code already says — comment only what a reader cannot recover from the file
type: standard
author: anshroboto
date: 2026-07-21
---
Never write a comment that explains what the code already says — a paraphrase of the lines under it, a value visible in the diff (`// 4px to match Figma` belongs in the ticket), a section signpost, a restated signature, or an attribution of a change. Comment only what a reader cannot recover from the file: discovered external-system behaviour, a workaround with a link and a removal condition, a non-obvious invariant or ordering constraint. AI diffs narrate every block by default; hold them to the same bar.
Loading