chore: onboard Serena — add .serena with project memories
Сохраняем онбоардинг-память проекта (core, tech_stack, conventions, suggested_commands, task_completion) в .serena и коммитим служебную директорию, чтобы она была доступна на сервере. Директория НЕ исключена в .gitignore (локально исключаются только cache и project.local.yml).
This commit is contained in:
39
.serena/memories/conventions.md
Normal file
39
.serena/memories/conventions.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# conventions
|
||||
|
||||
## Стиль / кодстайл
|
||||
- Стандартный Go-стиль; гофм `gofmt`/`go fmt ./...`. Документация-комментарии и
|
||||
package-doc на русском языке (в START-комментариях файлов и doc-комментариях).
|
||||
- Типизация: строгие типы, интерфейсы для абстракций (Decider, LiveProber).
|
||||
- Свой тип `config.Duration` для времени (YAML-строки "5s"/"10m"), метод `.Duration()`.
|
||||
|
||||
## Обработка ошибок
|
||||
- Ошибки классифицируются по идентификаторам классов в исходниках (см. ниже).
|
||||
- Ошибка-обёртка: `fmt.Errorf("%w: %v", ErrXxx, err)`.
|
||||
- `errors.Join` для склейки нескольких ошибок валидации (config.Validate).
|
||||
|
||||
## Классы ошибок (маркируются в коде, документированы в README)
|
||||
| Блок | Коды | Где |
|
||||
|---|---|---|
|
||||
| C | C1–C4 | internal/config |
|
||||
| A | A1–A4 | internal/analyst |
|
||||
| M | M1–M5 | internal/chat |
|
||||
| O | O1–O4 | internal/opencode |
|
||||
| S | S1–S5 | internal/storage |
|
||||
| W | W1–W5 | internal/worker |
|
||||
| E | E1–E4 | internal/worker (репозитории) |
|
||||
| R | R1–R6 | internal/worker/review_errors.go |
|
||||
| U | U1–U6 | internal/update |
|
||||
|
||||
## Архитектурные конвенции
|
||||
- **Composition root** — internal/app; подсистемы собираются там, лимиты Core
|
||||
(MaxTurns=15, MaxConfirmCycles=3, MaxQuestionsPerTurn=5) в core.New.
|
||||
- **Агенты** (analyst.md/dev.md/reviewer.md) — markdown-промпты, встроены через go:embed
|
||||
(internal/agents/*.md + embed.go), распаковываются в config_dir. Вердикт — строгий JSON.
|
||||
- Репо-клонирование/воркеры — через gitops; ветки задач `feat/<taskTag>` (см. mem:core).
|
||||
- Обратная совместимость: поле `Repo` (одиночный) и `Repos` (список); EffectiveRepos/
|
||||
SetReposFromDB/ReposJoined в storage/models.go.
|
||||
|
||||
## Версии
|
||||
- `app.Version` — семантическая major.minor.patch (ручной инкремент: patch=фиксы,
|
||||
minor=новая обратно-совместимая функциональность, major=несовместимые изменения).
|
||||
- `main.version` (ldflag) — build-идентификатор `commit-<sha7>`, отдельно от app.Version.
|
||||
51
.serena/memories/core.md
Normal file
51
.serena/memories/core.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# core
|
||||
|
||||
Ratatoskr-go — оркестратор конвейера Ratatoskr (порт с Python на Go) в единый
|
||||
статический бинарь (CGO_ENABLED=0). Субагенты запускаются через внешний процесс
|
||||
[opencode](https://opencode.ai). Взаимодействие — Telegram-бот.
|
||||
|
||||
## Структура (модули internal/)
|
||||
|
||||
```
|
||||
cmd/ratatoskr/ точка входа, сборка бинаря; main.version и main.updateToken вшиваются ldflag'ом
|
||||
internal/
|
||||
app/ composition root/DI: App.New -> config.Load+Validate, ResolveExePaths, storage, Runner, Analyst, Core, Worker, Updater. packageOwner="kamelion", Version="0.1.0"
|
||||
config/ YAML+env загрузка (${VAR:-default}), defaults, validate C1-C4
|
||||
chat/ мультиканальный Router; telegram — long-poll канал. Коды M1-M5
|
||||
core/ state-machine задач + Decider/analyst интерфейс. Коды D3/D4
|
||||
analyst/ аналитик: промпт + разбор JSON-вердикта (opencode agent). Коды A1-A4
|
||||
worker/ polling-планировщик + dev/reviewer-конвейер + gitops. Коды W*, E*, R*
|
||||
agents/ встроенные opencode-агенты (analyst.md, dev.md, reviewer.md) через go:embed
|
||||
opencode/ обёртка запуска opencode, LiveRegistry, парсинг вердикта. Коды O1-O4
|
||||
storage/ SQLite (modernc.org/sqlite, без CGO): tasks, traces, task_history. Коды S1-S5
|
||||
update/ автообновление из Gitea Packages. Коды U1-U6
|
||||
```
|
||||
|
||||
## Ключевые инварианты
|
||||
|
||||
- **Команды/ядро:** Core.ProcessTurn — state-machine поверх storage. Команды:
|
||||
/start /cancel /skip /retry N /status N /continue N. Активная задача — одна на чат.
|
||||
- **Фазы аналитика (Decision.Phase):** `ask` (уточняющие вопросы), `propose` (правки
|
||||
черновика), `ready` (черновик полон как есть), `abort` (тема вне проекта). propose и ready
|
||||
в core обрабатываются одинаково.
|
||||
- **Статусы задач:** draft→collecting→ready→approved→running→success/failed/timeout,
|
||||
плюс cancelled/aborted/closed. approved — финальное одобрение («создавай»), после чего
|
||||
воркер берёт задачу. IsValidTransition/IsTerminal в storage/models.go.
|
||||
- **Decider/Worker/Analyst/Reviewer:** Decider=analyst интерфейс (analyst пакет реализует);
|
||||
Worker — polling-планировщик dev-агента; Reviewer проверяет diff dev-ветки (R1-R6),
|
||||
вердикт JSON {passed, critical_issues, solid_violations, comments}.
|
||||
- **gitops (worker):** worker работает с worktrees; feature-ветка = `feat/<taskTag>` от
|
||||
origin/main; ensureBranch (reset --hard + clean -fd + checkout -B), branchDiff
|
||||
(`origin/main...<branch>`), push через http.extraHeader, токен как Bearer.
|
||||
- **Пути «всё рядом с .exe»:** относительные db/worktree резолвятся от каталога бинаря
|
||||
(ExeDir), не от cwd. config.yaml ищутся рядом с бинарём, фоллбэк cwd.
|
||||
- **Автообновление:** авто = только Check+уведомление; замена — по /update. Версии в
|
||||
Gitea Packages `commit-<sha7>/` (не `latest/`). Вердикты агентов — строгий JSON.
|
||||
|
||||
## Контракты (не ломать)
|
||||
|
||||
- `App.New(configPath, version, updateToken string)` — сигнатура.
|
||||
- `packageOwner` — константа "kamelion" (не плодить vars/ldflag/конфиг).
|
||||
- `update.Updater` — создаётся структурой `&update.Updater{...}`, конструктора нет.
|
||||
|
||||
См. также `mem:tech_stack`, `mem:conventions`, `mem:task_completion`, `mem:suggested_commands`.
|
||||
33
.serena/memories/memory_maintenance.md
Normal file
33
.serena/memories/memory_maintenance.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Memory Maintenance
|
||||
|
||||
## Discovery Model
|
||||
|
||||
- Core principle: progressive discovery through references, building a graph of memories.
|
||||
- Initially, agents are provided with the list of all memories (names only).
|
||||
- Agents should read `mem:core` as the top-level entry point (graph root).
|
||||
This memory should contain references to other memories covering major project domains.
|
||||
The referenced memories shall, in turn, shall contain references to even more specific memories, and so on.
|
||||
The depth of the graph shall depend on the project complexity.
|
||||
- Use topics/folders to group related memories in order to make the content structure explicit.
|
||||
Folders can mirror project structure (e.g. modules like frontend/backend) or topics like debugging, architecture, etc.
|
||||
- Memory references must use a mem: prefix inside backticks, e.g. `mem:frontend/core`.
|
||||
The surrounding text should clearly indicate when to read the memory/which content to expect.
|
||||
The text should provide more precise guidance than the memory name alone,
|
||||
i.e. avoid a reference like "frontend debugging: `mem:frontend/debugging` and instead make clear which aspects of frontend debugging are covered.
|
||||
- Memories themselves should not contain information about when to read them; this is the responsibility of the referring memory.
|
||||
|
||||
## Style
|
||||
|
||||
Dense agent notes, not prose docs. Prefer invariants, terse bullets.
|
||||
Avoid obvious context, rationale, and examples unless they prevent likely mistakes.
|
||||
Keep guidance durable and generalizable, not task-local.
|
||||
|
||||
## Add/update threshold
|
||||
|
||||
Add or update memories only with stable, non-obvious project conventions that avoid complex rediscovery in the future.
|
||||
Do not add: quick-read facts; generic language/framework knowledge; one-off task notes; volatile line-level details; behavior likely to change soon.
|
||||
|
||||
## Maintenance Actions
|
||||
|
||||
- Renaming memories: References are updated automatically if handled via Serena's memory rename tool.
|
||||
- Checking for stale memories (e.g. after deletion): Call `serena memories check` for a report.
|
||||
27
.serena/memories/suggested_commands.md
Normal file
27
.serena/memories/suggested_commands.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# suggested_commands
|
||||
|
||||
## Сборка / проверки (из корня репо)
|
||||
- `go test ./... -v -count=1 -timeout 120s` (или `make test`) — все тесты.
|
||||
- `go vet ./...` (или `make vet`).
|
||||
- `go fmt ./...` (или `make fmt`).
|
||||
- `go build -o ratatoskr ./cmd/ratatoskr/` (или `make build`).
|
||||
- `./ratatoskr -config config.yaml` (или `make run`).
|
||||
- `./ratatoskr -version` — показать версию бинаря.
|
||||
- Кросс-сборка: `make cross` (linux/amd64 + windows/amd64).
|
||||
|
||||
## Go-тулчейн
|
||||
Хост без `go` в PATH — экспорт вручную:
|
||||
```
|
||||
export PATH=/opt/data/.local/go/bin:$PATH
|
||||
```
|
||||
На машине разработки (Windows, cmd) — обычный system Go.
|
||||
|
||||
## git (worktree-процесс Ratatoskr)
|
||||
- Feature-ветка: `feat/<taskTag>`, база — `origin/main`. Пример проверки diff всей ветки:
|
||||
`git diff origin/main...HEAD`.
|
||||
- Проверить состав отслеживаемых файлов (например наличие .serena): `git ls-files`.
|
||||
- Статус: `git status`. Лог: `git log --oneline -10`.
|
||||
|
||||
## Замечания про среду
|
||||
- ОС Windows + PowerShell 5.1 (shell: powershell) — команды собирать/запускать с учётом
|
||||
этом (нет `&&`; использовать `;`/`if ($?) {}`; & для путей с пробелами).
|
||||
15
.serena/memories/task_completion.md
Normal file
15
.serena/memories/task_completion.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# task_completion
|
||||
|
||||
Считается, что задача по коду выполнена строго после:
|
||||
|
||||
1. **Формат/линт:** `go fmt ./...` (без неотформатированных файлов).
|
||||
2. **Тесты:** `go test ./... -v -count=1 -timeout 120s` — все проходят (`make test`).
|
||||
3. **Статический анализ:** `go vet ./...` — чисто (`make vet`).
|
||||
4. **Сборка:** `go build -o ratatoskr ./cmd/ratatoskr/` (`make build`) — компилируется.
|
||||
(Кросс-сборка `make cross` — только при необходимости.)
|
||||
5. **Пересмотр контрактов:** если менялась сигнатура `App.New(configPath, version,
|
||||
updateToken string)` — обновить вызовы в `internal/app/app_test.go` (иначе go vet падает).
|
||||
6. Коммит осмысленными атомарными коммитами в feature-ветку `feat/<taskTag>` от origin/main.
|
||||
|
||||
Рабочий процесс Ratatoskr (агент dev в этом конвейере): изучить код, реализовать так, чтобы
|
||||
все acceptance criteria были закрыты, закоммитить в ветку, вернуть отчёт.
|
||||
30
.serena/memories/tech_stack.md
Normal file
30
.serena/memories/tech_stack.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# tech_stack
|
||||
|
||||
## Язык / рантайм
|
||||
- Go **1.25.0** (go.mod `go 1.25.0`). Модуль `github.com/kamelion/ratatoskr-go`.
|
||||
- Сборка: статический бинарь, `CGO_ENABLED=0`. Локальный Go-тулчейн на хосте:
|
||||
`export PATH=/opt/data/.local/go/bin:$PATH` (go1.25.0 linux/amd64).
|
||||
|
||||
## Основные зависимости (go.mod)
|
||||
- `gopkg.in/yaml.v3 v3.0.1` — парсинг config.yaml.
|
||||
- `modernc.org/sqlite v1.56.0` — SQLite без CGO (чистый Go).
|
||||
- (indirect) google/uuid, go-humanize, mattn/go-isatty, x/sys, modernc.org/libc/mathutil/memory.
|
||||
|
||||
## Внешние процессы
|
||||
- **opencode** (opencode.ai) — внешний процесс для субагентов (analyst/dev/reviewer).
|
||||
Управляется через internal/opencode (Runner, LiveRegistry). Настраивается в конфиге
|
||||
(opencode.bin / config / config_dir / hard_timeout / idle_timeout / poll_ms).
|
||||
|
||||
## Сборка / Makefile
|
||||
- `make build` — go build -ldflags="-s -w -X main.version=commit-<sha7> -X main.updateToken=..." -o ratatoskr ./cmd/ratatoskr/.
|
||||
- `make test` — go test ./... -v -count=1 -timeout 120s.
|
||||
- `make vet` — go vet ./... `make fmt` — go fmt ./...
|
||||
- `make run` — build + ./ratatoskr -config config.yaml.
|
||||
- `make cross` — кросс-сборка linux/amd64 + windows/amd64 (ratatoskr-windows-amd64.exe — Windows-машина Камиля).
|
||||
- GIT_SHA вшивается в main.version; UPDATE_TOKEN — в main.updateToken (секрет только у CI).
|
||||
|
||||
## CI (.gitea/workflows/ci.yaml)
|
||||
- Job `test`: go test ./... + go vet ./....
|
||||
- Job `build-and-package` (matrix linux/amd64+windows/amd64): собирает и публикует в
|
||||
Gitea Packages на `main` в версию `commit-<sha7>/` + companion-файлы `.version`/`.sha256`.
|
||||
- Секреты: TC_GITEA_TOKEN (write:packages), TC_UPDATE_TOKEN (read:package), GIT_MAIN_URL.
|
||||
Reference in New Issue
Block a user