From 474ef9f424db74e527fdf03879d145fe6957f656 Mon Sep 17 00:00:00 2001 From: alexion Date: Wed, 2 Sep 2026 22:03:42 -0400 Subject: [PATCH] docs(agents): fold comment guidance into writing section --- AGENTS.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index f658133..04034ae 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -14,6 +14,8 @@ - Use `docs/technical-writing.md` and `docs/dictionary.md` for authored prose, comments, and Markdown formatting. Use the nearest project dictionary for project-specific domain language. +- Write comments only where they earn their place. + Comments must explain purpose, preconditions, invariants, or non-obvious consequences. ## Pull requests @@ -59,12 +61,6 @@ Before ending a workflow turn, perform the obvious next step, such as showing the next review item after applying an accepted change. If the workflow is paused, say that plainly instead of using a dangling transition like "continuing" or "next". -## Comments - -- Follow `docs/technical-writing.md` for comments and authored prose. -- Write comments only where they earn their place. - Comments must explain purpose, preconditions, invariants, or non-obvious consequences. - ## Corrections - When you discover that your belief about a project fact or convention was wrong, record the correction.