Denozordec
4c23232c4e
- Added a section on Conventional Commits in AGENTS.md, detailing the process for generating commit messages. - Enhanced README.md with references to the Conventional Commits rules and the necessary scripts for generating commit messages. - Clarified the format for commit messages, specifying the language requirements for headers and bodies.
Документация EvoBGP
Структурированные материалы по проекту на русском языке. Детальный перечень полей и ответов HTTP API — в openapi.yaml (OpenAPI 3.1).
По роли читателя
- ИИ-агент / ассистент в репозитории — ../AGENTS.md: с чего начать чтение, карта
internal/иcmd/, что не тащить в контекст. Инженерные правила: ../.cursor/rules/engineering.mdc (общие), ../.cursor/rules/web-shadcn.mdc (Web UI), ../.cursor/rules/networking-bird.mdc (BIRD2/BGP/IP). - Оператор / DevOps — quickstart.md, architecture.md, access.md, deploy/compose/docker-compose.yaml.
- Разработчик бэкенда или интегратор API — api.md, access.md, openapi.yaml, исходники маршрутов в
internal/httpapi/. - Разработчик фронтенда — quickstart.md (раздел про
web/и CORS), api.md, ../web/README.md.
Оглавление
| Раздел | Описание |
|---|---|
| overview.md | Ключевые возможности системы |
| quickstart.md | Быстрый запуск: готовые образы из git.shts.su, Docker Compose, локальный Go, веб |
| architecture.md | Компоненты, потоки данных, пакеты |
| manual.md | Подробное руководство по модулям, процессам и API |
| api.md | REST: префикс /v1, публичные маршруты, ссылки на OpenAPI |
| router-lists-ui-integration.md | Интеграция router-lists-ui с EvoBGP API (DOMAINS/IP_RANGES/AS_PREFIXES/communities) |
| access.md | Выдача доступа: API-ключи, роли, нода, CORS |
| openapi.yaml | Источник правды по контракту API |
| OPENAPI-GITEA.md | Как открыть HTML-документацию API (в т.ч. из Gitea) |
| evobgp-api-sketches.md | Ранний черновик идей API (контекст, не замена OpenAPI) |
Инженерные правила (Cursor / разработка)
| Файл | Область |
|---|---|
| ../.cursor/rules/engineering.mdc | Go, API, migrations, security, enforcement |
| ../.cursor/rules/web-shadcn.mdc | SvelteKit, shadcn-svelte |
| ../.cursor/rules/networking-bird.mdc | BIRD2, BGP policy, IP/CIDR |
| ../.cursor/rules/conventional-commits.mdc | Conventional Commits (заголовок EN, тело RU) |
Сообщения коммитов (Cursor)
После git add попросите агента: «сгенерируй коммит по staged», «закоммить», «commit message» — агент обязан первым делом запустить scripts/commit/staged-context.ps1, затем скилл commit-message (заголовок EN, тело RU, auto-split). Просмотр групп вручную: powershell -NoProfile -File scripts/commit/staged-context.ps1 | ConvertFrom-Json.
Репозиторий и CI
- ../.gitea/README.md — Gitea Actions, runner, сборка образов и push в Container Registry.