From fa943573742f3c401623747832251a5923fdde91 Mon Sep 17 00:00:00 2001 From: jamesread Date: Fri, 24 Oct 2025 21:31:54 +0100 Subject: [PATCH] chore: Stop AI agents adding superflous comments --- AGENTS.md | 1 + 1 file changed, 1 insertion(+) diff --git a/AGENTS.md b/AGENTS.md index a64f036..11c6c7e 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -35,6 +35,7 @@ If you are looking for OliveTin's AI policy, you can find it in `AI.md`. - Footer visibility is controlled by `showFooter` from Init API; tests may assert the footer is absent when config disables it. ### Coding Standards (Go) +- Avoid adding superflous comments that explain what the code is doing. Comments are only to describe business logic decisions. - Prefer clear, descriptive names; avoid 1–2 letter identifiers. - Use early returns and handle edge cases first. - Do not swallow errors; propagate or log meaningfully.