WindaUser/web-vnc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(agents): require keeping AGENTS.md in sync with the code

Browse Source 
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.
This commit is contained in:
Codex
2026-07-30 17:43:03 +03:00
parent b89477fb87
commit cf0915878b
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+13
View File
@@ -2,6 +2,19 @@
Руководство для агентов (и людей), работающих с этим репозиторием.
## Сопровождение этого файла (ВАЖНО)
- **AGENTS.md должен отражать актуальное состояние кода.** Это живой документ,
а не одноразовая справка.
- При любом изменении, влияющем на: архитектуру, состав пакетов/файлов, флаги
CLI или env-переменные (`WEBVNC_*`), протокол/поведение гейтвея, скрипты,
кодировки файлов, процесс сборки/запуска или известные ограничения —
**обязательно обнови соответствующий раздел AGENTS.md в том же коммите**.
- Если заметил расхождение между AGENTS.md и реальным кодом (функция переименована,
файл удалён, флаг изменён и т.п.) — сначала приведи AGENTS.md в соответствие
с кодом, затем продолжай работу. Не оставляй устаревшие инструкции.
- Коммит, меняющий поведение/структуру, но не трогающий AGENTS.md при расхождении,
считается неполным.
## Что это
`web-vnc` — один Go-бинарник, который открывает доступ к рабочему столу (VNC)