Files
EvoBGP/AGENTS.md
T
Denozordec a2cbfacd45
CI / changes (push) Successful in 5s
CI / openapi (push) Successful in 25s
CI / go (push) Successful in 24s
CI / docker-web (deploy/docker/evobgp-web/Dockerfile, , evobgp-web) (push) Successful in 1m1s
CI / docker-web (deploy/docker/evobgp-web/Dockerfile, evobgp-all, evobgp-web-all) (push) Successful in 1m1s
CI / docker-bird (push) Has been skipped
CI / bird2 (push) Successful in 15s
CI / docker-go (evobgp-all, 1, deploy/docker/gobinary/Dockerfile, , evobgp-all) (push) Has been cancelled
CI / docker-go (evobgp-api, 1, deploy/docker/gobinary/Dockerfile, , evobgp-api) (push) Has been cancelled
CI / docker-go (evobgp-deploy, 0, deploy/docker/gobinary/Dockerfile, , evobgp-deploy) (push) Has been cancelled
CI / docker-go (evobgp-ingest, 0, deploy/docker/gobinary/Dockerfile, , evobgp-ingest) (push) Has been cancelled
CI / docker-go (evobgp-node, 0, deploy/docker/gobinary/Dockerfile, , evobgp-node) (push) Has been cancelled
CI / docker-go (evobgp-render, 0, deploy/docker/gobinary/Dockerfile, , evobgp-render) (push) Has been cancelled
CI / docker-go (evobgp-scheduler, 0, deploy/docker/gobinary/Dockerfile, , evobgp-scheduler) (push) Has been cancelled
CI / docker-go (deploy/docker/evobgp-agent/Dockerfile, , evobgp-agent) (push) Successful in 1m1s
feat: update BGP community structure and related documentation. Refactor BGP community handling by renaming fields from 'name' and 'kind' to 'community' and 'title' across the codebase. Update OpenAPI specifications, database interactions, and UI components to reflect these changes, enhancing clarity and consistency in community management.
2026-04-06 14:52:29 +07:00

4.1 KiB
Raw Blame History

Руководство для ИИ-агентов (экономия контекста)

Краткие ориентиры по репозиторию EvoBGP, чтобы не тратить токены на полное сканирование дерева и повторное чтение одних и тех же файлов.

С чего начать (минимум чтения)

  1. docs/README.md — оглавление и роли читателя.
  2. docs/architecture.md — компоненты cmd/, карта internal/, потоки данных (одного этого файла обычно достаточно для ориентации).
  3. Задача-специфично: docs/api.md, docs/access.md, web/README.md — только если меняете API, доступ или фронт.

Источник правды по HTTP-контракту: docs/openapi.yaml. Не дублируйте длинные фрагменты спецификации в ответах — ссылайтесь на путь и тег/операцию.

Карта кода (куда смотреть)

Область Где искать
REST, auth, CORS internal/httpapi/
Бизнес-слой и абстракция хранилища internal/store/
PostgreSQL internal/repository/, internal/db/, migrations/
Фоновые задачи internal/jobs/
Цепочка refresh модуля (ingest+render, BIRD preview) internal/pipeline/
Конфиг BIRD, birdc internal/birdfmt/, internal/birddeploy/
Бандлы и подписи internal/bundle/, internal/signing/
Точки входа процессов cmd/*/
Веб (SvelteKit) web/
Compose, деплой deploy/compose/

Точки входа бинарников и их роли — в таблице в начале docs/architecture.md.

Как не раздувать контекст

  • Сначала узкий поиск: grep/поиск по символу или короткий семантический запрос по одной папке (internal/httpapi/, internal/pipeline/, …), а не чтение всех .go подряд.
  • Читайте файлы целиком только при необходимости: большие файлы — с offset/limit или по найденным строкам.
  • Не подтягивайте в контекст: web/node_modules/, сгенерированные артефакты сборки, бинарники, полный openapi.html, если достаточно openapi.yaml.
  • Повторное использование: если docs/architecture.md уже описывает поток — не пересказывайте его длинно; укажите документ и конкретный подпункт задачи.
  • Длинные планы: .cursor/plans/*.plan.md — для истории решений; для навигации пользователю достаточно docs/; не читайте план целиком без причины.

Команды и среда

  • Консоль пользователя: PowerShell; пути в стиле deploy\compose.
  • Быстрый старт и переменные: docs/quickstart.md, README.md.

Язык документации проекта

Пользовательская документация в docs/ — преимущественно на русском. Комментарии и имена в коде — в существующем стиле репозитория.

Svelte / фронтенд

При правках web/**/*.svelte или Svelte-модулей следуйте навыкам/инструментам проекта (официальный Svelte MCP и скиллы Cursor, если подключены).