Skip to content

docs(agents-md): tell agents to file an issue when they hit one - #169

Merged
defangdevs merged 1 commit into
masterfrom
docs/agents-md-file-issues
Aug 2, 2026
Merged

docs(agents-md): tell agents to file an issue when they hit one#169
defangdevs merged 1 commit into
masterfrom
docs/agents-md-file-issues

Conversation

@defangdevs

Copy link
Copy Markdown
Owner

Motivation

AGENTS.md said nothing about filing issues, so problems agents hit mid-task stayed in session transcripts: a workaround gets applied, the PR moves on, and the next agent — starting with none of that context — rediscovers the same thing from scratch.

Prompted by defangdevs/local-channels#10, which came out of exactly this failure mode. While driving #168, the box's own PR spawned two duplicate hook-* triage sessions (CI-outcome events bypass ignoreSenders by design, so the standing watch fired on a PR a session already owned). Easy to shrug off with agent-box-session rm and never write down.

Changes

A new "Filing Issues" section in AGENTS.md, before the commit/PR guidelines:

  • When: bug, design gap, stale doc, flaky check, or surprising behavior you had to work around — including mid-task on something unrelated, including already-worked-around, including small.
  • Where: the repo that owns the fix, not the one you happen to be sitting in (local-channels for local-webhook behavior, agent-box for the module and the box), with cross-links when symptom and fix live apart.
  • What: observation, smallest repro, where the fix belongs; options with a recommendation rather than leaving the next reader to re-derive them.
  • Search open issues first; add to an existing one over opening a near-duplicate. If a PR only papers over the problem, say so and link the issue.

User-visible / security effects

None — documentation for agents working in this repo. No module, no AWS, no IAM, no networking impact.

Checks run

Markdown-only change touching no Nix source, so no flake check is affected; modules/agent-box.nix is untouched and module-generated-up-to-date is unaffected. CI runs the full suite regardless.

🤖 Generated with Claude Code

https://claude.ai/code/session_01PsqGhkpjsb4kKAdVz25xKN

Nothing said to write problems down, so they stayed in session transcripts:
a workaround gets applied, the PR moves on, and the next agent rediscovers
the same thing from scratch. Add a "Filing Issues" section covering the
trigger (bug, design gap, stale doc, flaky check, surprising behavior you
worked around), which repo owns the fix (local-channels vs. agent-box, with
cross-links when symptom and fix differ), and what the issue should contain
— observation, smallest repro, where the fix belongs, options with a
recommendation. Search first, add to an existing issue over near-duplicates.

Prompted by defangdevs/local-channels#10, which came out of exactly this:
the box's own PR spawned duplicate hook-* triage sessions and the finding
would otherwise have lived only in a transcript.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PsqGhkpjsb4kKAdVz25xKN
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants