From 64ba5e2ae394e5041851d5d4e22cd9d8fd92719f Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Wed, 13 May 2026 16:13:33 +0100 Subject: [PATCH] docs: add inline comment guidance --- AGENTS.md | 1 + 1 file changed, 1 insertion(+) diff --git a/AGENTS.md b/AGENTS.md index c666c8556ea..49250ade9bd 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -36,6 +36,7 @@ Skills own workflows; root owns hard policy and routing. - Channels are implementation under `src/channels/**`; plugin authors get SDK seams. Providers own auth/catalog/runtime hooks; core owns generic loop. - Hot paths should carry prepared facts forward: provider id, model ref, channel id, target, capability family, attachment class. Do not rediscover with broad plugin/provider/channel/capability loaders. - Do not fix repeated request-time discovery with scattered caches. Move the canonical fact earlier; reuse prepared runtime objects; delete duplicate lookup branches. +- Inline code comments: brief notes for tricky, bug-prone, or previously buggy logic. - Gateway protocol changes: additive first; incompatible needs versioning/docs/client follow-through. - Config contract: exported types, schema/help, metadata, baselines, docs aligned. Retired public keys stay retired; compat in raw migration/doctor only. - Prompt cache: deterministic ordering for maps/sets/registries/plugin lists/files/network results before model/tool payloads. Preserve old transcript bytes when possible.