From 0486571750d4d03b853d1047350ce96025919be2 Mon Sep 17 00:00:00 2001 From: aayushshah15 Date: Mon, 16 Mar 2026 10:47:47 +0000 Subject: [PATCH] docs: add code comments guideline to agents guide Co-authored-by: Codesmith --- AGENTS.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index de8a0f6dc115..2ba15a7f124f 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -43,6 +43,10 @@ gofmt -w . gofmt -w path/to/file.go ``` +## Code Style + +- **Comments**: Don't comment obvious code. Do add concise comments when the rationale (the "why") behind a decision isn't obvious from the code itself — e.g., non-obvious business rules, workarounds, performance trade-offs, or constraints that would require digging through history to understand + ## Workflow Summary 1. Create a branch from `master`