From cf0915878b657db9b81cca6329dbe61c86119373 Mon Sep 17 00:00:00 2001 From: Codex Date: Thu, 30 Jul 2026 17:43:03 +0300 Subject: [PATCH] docs(agents): require keeping AGENTS.md in sync with the code Add a maintenance note: AGENTS.md is a living document and must be updated in the same commit whenever code/flags/structure/scripts change, and reconciled first whenever it diverges from the code. --- AGENTS.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 98ad4ee..657e917 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -2,6 +2,19 @@ Руководство для агентов (и людей), работающих с этим репозиторием. +## Сопровождение этого файла (ВАЖНО) + +- **AGENTS.md должен отражать актуальное состояние кода.** Это живой документ, + а не одноразовая справка. +- При любом изменении, влияющем на: архитектуру, состав пакетов/файлов, флаги + CLI или env-переменные (`WEBVNC_*`), протокол/поведение гейтвея, скрипты, + кодировки файлов, процесс сборки/запуска или известные ограничения — + **обязательно обнови соответствующий раздел AGENTS.md в том же коммите**. +- Если заметил расхождение между AGENTS.md и реальным кодом (функция переименована, + файл удалён, флаг изменён и т.п.) — сначала приведи AGENTS.md в соответствие + с кодом, затем продолжай работу. Не оставляй устаревшие инструкции. +- Коммит, меняющий поведение/структуру, но не трогающий AGENTS.md при расхождении, + считается неполным. ## Что это `web-vnc` — один Go-бинарник, который открывает доступ к рабочему столу (VNC)