From: Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Date: Fri, 17 Apr 2026 19:59:11 +0000 (+0200)
Subject: agents: Add a note about having the issue ID in test names
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=bbb42b5a6a5502f5ffb09457a847bee21cf155ca;p=brevno-suite%2Fhugo

agents: Add a note about having the issue ID in test names
---

diff --git a/AGENTS.md b/AGENTS.md
index 42c0706b6..9972596ac 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -9,6 +9,7 @@
 * This is a project with a long history; assume that a similiar problem has been solved before, look hard for helper functions before creating new ones.
 * In tests, use `qt` matchers (e.g. `b.Assert(err, qt.ErrorMatches, ...)`) instead of raw `if`/`t.Fatal` checks.
 * In tests, always use the latest Hugo specification, e.g. for layouts, it's `layouts/page.html` and not `layouts/_default/single.html`, `layouts/list.html` and not `layouts/_default/list.html`
+* Never name tests `TestIssue1234`; if this e.g. is about fixing an issue, use the issue ID as a suffix, as in `TestUpperCaseTitlesCreatesHavocIssue1234`. And note: No underscores in func names.
 * Brevity is good. This applies to code, comments and commit messages. Don't write a novel.
 * Use `./check.sh ./somepackage/...` when iterating.
 * Use `./check.sh` when you're done.