From 6db201571922ea08f29b7f16a4c231ee2daf42f0 Mon Sep 17 00:00:00 2001 From: "Jeong, YunWon" Date: Fri, 6 Feb 2026 11:17:09 +0900 Subject: [PATCH] [AGENTS] guideline for comments --- AGENTS.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 3dd13f6b967..b407328cffb 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -125,6 +125,11 @@ Run `./scripts/whats_left.py` to get a list of unimplemented methods, which is h - Follow Rust best practices for error handling and memory management - Use the macro system (`pyclass`, `pymodule`, `pyfunction`, etc.) when implementing Python functionality in Rust +#### Comments + +- Do not delete or rewrite existing comments unless they are factually wrong or directly contradict the new code. +- Do not add decorative section separators (e.g. `// -----------`, `// ===`, `/* *** */`). Use `///` doc-comments or short `//` comments only when they add value. + #### Avoid Duplicate Code in Branches When branches differ only in a value but share common logic, extract the differing value first, then call the common logic once.