Skip to content

Commit bcaa7f0

Browse files
committed
docs(agents): require concise commit messages + comments
- Commit messages: concise, point form, no Co-Authored-By lines. - Comments: one line on the non-obvious; never restate the code.
1 parent 2d8a58a commit bcaa7f0

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

‎AGENTS.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ here once; do not re-justify them per-command in code comments or docs.
6767
`tree-sitter-language-pack`) that backs the symbol-navigation tools.
6868
`textual` is an optional `[tui]` extra. Build dep is `hatchling`.
6969
- **Comments / docstrings**: don't add them to code you didn't change.
70-
Don't add type annotations to functions you didn't modify. Don't refactor
70+
When you do comment, one line on the non-obvious — never restate the
71+
code. Don't add type annotations to functions you didn't modify. Don't refactor
7172
surrounding code "while you're there." Scope creep is a review-blocker.
7273
- **Module boundaries** are enforced by [tach](https://docs.gauge.sh/).
7374
`cli → workflows → agents → tools → sandbox`. Workflows never import
@@ -140,6 +141,8 @@ All five must pass; keep the suite green.
140141
`feat(scope):`, `fix(scope):`, `ci:`, `docs:`, `bench:`, etc. The
141142
scope (e.g. `review`, `sandbox`, `graph`) matches a directory under
142143
`src/agent6/` or a top-level area.
144+
- Keep messages concise: imperative subject; a body only for non-obvious
145+
*why*, in point form not prose. No `Co-Authored-By` lines.
143146
- Security-relevant commits include a `Security review note:` paragraph
144147
explaining what surface changed.
145148
- Do not push. `git.allow_push = false` is the user-side enforcement;

0 commit comments

Comments
 (0)