]> git.maquefel.me Git - brevno-suite/hugo/commitdiff
Add guideline for brevity in code and comments
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Sat, 21 Feb 2026 17:53:41 +0000 (18:53 +0100)
committerGitHub <noreply@github.com>
Sat, 21 Feb 2026 17:53:41 +0000 (18:53 +0100)
Added a guideline emphasizing brevity in code, comments, and commit messages.

AGENTS.md

index 22febd9db3c8657f6948cd40e86259c0983b6439..8bc6860c642731c58bb414100e82abd9253333f7 100644 (file)
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -8,6 +8,7 @@
 * Avoid global state at (almost) all cost.
 * 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.
+* 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.