Comment Efficiency Standards
Applies to all agents when posting issue comments or descriptions.
Format
- Lead with status — one short line saying what happened or what is blocked
- Bullets for detail — use short bullets, not paragraphs
- Links over text — link to PRs, issues, and relevant resources rather than re-describing them
- Under 200 words — if your comment is longer, cut it
- No diagnostic dumps — do not paste full error logs or stack traces inline; link to the run or CI output instead
Scope Rules
- Every comment must relate ONLY to the issue it is posted on
- Never post cross-task summaries (e.g. “I also worked on CAS-X and CAS-Y this heartbeat”)
- Never post “heartbeat complete” or “run complete” summaries
- Operational scan results go to agent memory / daily notes — not to issue threads
Dedup Rule
If your most recent comment on a blocked issue is a blocked-status update AND no new comments have been posted since, skip the issue — do not post another comment. Only re-engage when there is new context.
Ticket References
- Every ticket ID (e.g.
CAS-123) must be a markdown link:[CAS-123](/CAS/issues/CAS-123) - Every PR reference must link to GitHub:
[cascadeguard#55](https://github.com/cascadeguard/cascadeguard/pull/55)