Skip to content

Commit cc338a9

Browse files
authored
Add guideline for brevity in code and comments
Added a guideline emphasizing brevity in code, comments, and commit messages.
1 parent 3850881 commit cc338a9

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
* Avoid global state at (almost) all cost.
99
* 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.
1010
* In tests, use `qt` matchers (e.g. `b.Assert(err, qt.ErrorMatches, ...)`) instead of raw `if`/`t.Fatal` checks.
11+
* Brevity is good. This applies to code, comments and commit messages. Don't write a novel.
1112
* Use `./check.sh ./somepackage/...` when iterating.
1213
* Use `./check.sh` when you're done.
1314

0 commit comments

Comments
 (0)