Expand AGENTS.md with current repo and reporting rules

This commit is contained in:
2026-07-09 11:19:10 +03:00
parent 4d859dc0a6
commit db0c1dede9
26 changed files with 1708 additions and 54 deletions

61
.agent/README.md Normal file
View File

@@ -0,0 +1,61 @@
# ProxyWarden Agent Kit
Этот каталог содержит инструкции для кодовых агентов, которые работают с ProxyWarden.
Главный файл — `AGENTS.md` в корне репозитория. Он задает инварианты и общие правила. Файлы в `.agent/skills` описывают конкретные режимы работы: backend, UI, security, Windows services, subscriptions/routing, testing/release и понятные отчеты.
## Как использовать
1. Прочитать корневой `AGENTS.md`.
2. Выбрать skill под задачу.
3. Перед изменением проверить релевантные чек-листы из `.agent/checklists`.
4. После изменения выполнить минимальные проверки.
5. Для любого нетривиального ответа использовать `communication-reporting`: коротко, по файлам, с проверками и рисками.
6. В финальном отчете явно указать, что было и не было проверено.
## Как агент должен писать ответы
По умолчанию агент пишет не техническую простыню, а короткий отчет:
```text
Коротко
Что изменилось по файлам
Важные места
Проверено
Не проверено
Риски
```
Для 2+ файлов желательно использовать таблицу `Файл / Что изменилось / Зачем`. В ответе должны быть конкретные пути файлов и человеческая причина изменения. Не надо пересказывать каждую строку diff, если пользователь не попросил.
Подробные правила лежат в `.agent/skills/communication-reporting/SKILL.md`, чек-лист — в `.agent/checklists/communication.md`. Да, это нужно отдельно прописывать, иначе агент опять напишет роман о своем внутреннем мире и двух переименованных переменных.
## Skill index
- `repository-orientation` — вход в проект, карта файлов, где искать source of truth.
- `rust-tauri-backend` — Tauri commands, Rust models, validation, storage, adapters.
- `react-typescript-ui` — React UI, typed invoke facade, readiness, components.
- `security-hardening` — CSP, секреты, elevated boundary, storage corruption, SSRF.
- `windows-services-powershell` — scripts, UAC, services, ProxiFyre/sing-box operations.
- `subscriptions-routing` — external SOCKS5, sing-box subscriptions, config generation, ping.
- `testing-ci-release` — build/test matrix, CI recommendations, release hygiene.
- `communication-reporting` — короткие планы, понятные сводки по файлам, отчеты без текстовой каши.
## Communication defaults
Перед длинным ответом или отчетом использовать:
- `.agent/skills/communication-reporting/SKILL.md`
- `.agent/checklists/communication.md`
- `.agent/checklists/explanation-quality.md`
- `.agent/templates/change-report.md` или `.agent/templates/user-facing-summary.md`
- `.agent/templates/file-impact-map.md`, если надо заранее показать, какие файлы будут затронуты
Главная идея: сначала короткая сводка, потом таблица файлов, потом проверки и риски. Не наоборот, потому что пользователь не обязан добывать смысл киркой.
## Что не является целью
- Перевод проекта в SaaS/gateway/server.
- Добавление облачного backend.
- Замена ProxiFyre без отдельной архитектурной задачи.
- Коммерциализация, telemetry-first подход или рекламная шелуха, этот вид пластика уже и так в океане.