From b05699db77f5fa97e75fe7d5fa3354c7cf01706d Mon Sep 17 00:00:00 2001 From: Daniel Salazar Date: Wed, 17 Jun 2026 17:07:20 -0700 Subject: [PATCH] fix: AGENTS.md cleanup (#3273) --- AGENTS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index a58a74b78..847f9a0a4 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -64,9 +64,9 @@ Keep comments light. Prefer self-documenting code — clear names, small functio - The _why_ is non-obvious (a hidden constraint, a workaround, a subtle invariant). - A non-trivial usage detail would otherwise trip the next reader. -Don't restate what the code already says. Don't write comments that reference the current task or PR — those rot. +Don't restate what the code already says. Don't write comments that reference the current task or PR or version of something — those rot. -**No ticket references in code or test comments.** Don't write `PUT-1234`, `AUTH-3`, `GUI-2`, `// fix for FOO-99`, `// per ROLLOUT-1`, or section headers like `// -- PUT-1020: ... --`. The ticket exists in git history and the issue tracker; the code should describe the *why* in domain terms ("logout cascade transparently invalidates...") not project-management terms ("the cascade from AUTH-3..."). Same rule for test-block names and section dividers — describe what's being tested, not which ticket asked for it. +**No ticket references in code or test comments.** Don't write `PUT-1234`, `AUTH-3`, `GUI-2`, `// fix for FOO-99`, `// per ROLLOUT-1`, or section headers like `// -- PUT-1020: ... --`. The ticket exists in git history and the issue tracker; the code should describe the _why_ in domain terms ("logout cascade transparently invalidates...") not project-management terms ("the cascade from AUTH-3..."). Same rule for test-block names and section dividers — describe what's being tested, not which ticket asked for it. **Use plain ASCII `-` in comment section dividers, not box-drawing characters.** Write `// -- Section name --`, not `// ── Section name ──`. The `─` (U+2500) character renders inconsistently in some editors and diff tools and adds nothing over `-`.