From d79e62fd2a65db64cea1fe18dffc4caac9a40be2 Mon Sep 17 00:00:00 2001 From: Ben Meadors Date: Sun, 10 May 2026 10:20:10 -0500 Subject: [PATCH] Chatty LLMs should pipe down --- .github/copilot-instructions.md | 1 + AGENTS.md | 1 + 2 files changed, 2 insertions(+) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index fe9af4359..8980aca1a 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -196,6 +196,7 @@ firmware/ - Prefer `LOG_DEBUG`, `LOG_INFO`, `LOG_WARN`, `LOG_ERROR` for logging - Use `assert()` for invariants that should never fail - C++17 features are available (`std::optional`, structured bindings, `if constexpr`, etc.) +- **Keep code comments minimal — one or two lines, max.** Comment only when the _why_ isn't obvious from the code; never restate what the next line does. No multi-paragraph block comments explaining straightforward changes. The diff and commit message carry the rationale; the code carries the behavior. ### Naming Conventions diff --git a/AGENTS.md b/AGENTS.md index cdccda1f4..113f12591 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -66,6 +66,7 @@ Key rotation to never trigger casually: only the **full** factory reset (`factor - **Don't speculate about firmware root causes.** When evidence doesn't support a classification, say "unknown" and list what would disambiguate. - **Run `trunk fmt` before proposing a commit.** The `trunk_check` CI gate will reject unformatted code. - **`confirm=True` on destructive MCP tools is a real gate, not a formality.** Don't bypass it via auto-approve settings. +- **Keep code comments minimal — one or two lines, max.** Comment only when the _why_ isn't obvious from the code; never restate what the next line does. No multi-paragraph block comments explaining straightforward changes. The diff and commit message carry the rationale; the code carries the behavior. ## Typical agent workflows