diff --git a/README.md b/README.md index e69de29..344b64e 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,46 @@ +# github-copilot + +Этот репозиторий содержит структуру кастомизаций GitHub Copilot для VS Code. +Основная цель — хранить и развивать специализированные агенты, навыки (skills), инструкции, хуки и готовые промпты в одном месте. + +## Что находится в репозитории + +Вся рабочая конфигурация лежит в директории `.github/`: + +- `agents/` — определения кастомных агентов (`*.agent.md`) +- `skills/` — каноничные навыки в формате `.github/skills//SKILL.md` +- `prompts/` — переиспользуемые одноразовые промпты (`*.prompt.md`) +- `instructions/` — правила поведения и код-стайл инструкции (`*.instructions.md`) +- `hooks/` — детерминированные lifecycle-хуки в JSON + +## Назначение + +Репозиторий используется как единая точка для: + +- настройки поведения Copilot под рабочие процессы команды +- автоматизации типовых задач (ревью ветки, Docker, TestLink, OpenWrt и др.) +- поддержки воспроизводимой архитектуры кастомизаций + +## Какие агенты уже есть + +В `.github/agents/` сейчас определены: + +- `Branch Review Engineer` +- `Docker Build & Test Engineer` +- `OpenWrt VPN & Network Engineer` +- `TestLink Autotest Engineer` + +## Как расширять + +1. Добавьте или обновите агент в `.github/agents/`. +2. Добавьте/обновите соответствующий навык в `.github/skills/`. +3. При необходимости создайте reusable промпт в `.github/prompts/`. +4. Добавьте инструкции в `.github/instructions/` для правил, которые должны применяться постоянно. +5. Используйте `.github/hooks/` только для детерминированной автоматизации, а не для описательных правил. + +## Принципы структуры + +- Один источник истины для каждого навыка — только в `.github/skills/`. +- Агенты и навыки разделены по ответственности. +- Инструкции короткие и прикладные, workflow-логика выносится в skills. +- Хуки быстрые, идемпотентные и недеструктивные.