Files
onboard2orch/checklists/ONBOARDING_CHECKLIST.md

3.3 KiB
Raw Blame History

Чеклист онбординга проекта в оркестратор

Пошаговое подключение нового проекта «под ключ». Каждый пункт — в репо ПОДКЛЮЧАЕМОГО проекта, не здесь.

Шаг 1. Регистрация проекта в орке

  • Создать проект в Plane, получить plane_project_id и префикс work-item (напр. ET, ORCH).
  • Создать git-репо проекта в Gitea.
  • Добавить запись в реестр орка ORCH_PROJECTS_JSON (env орка): plane_project_id → repo + work_item_prefix + name. См. orchestrator src/projects.py (ADR-0001).
  • Настроить вебхуки: Plane → /webhook/plane, Gitea → /webhook/gitea (HMAC-секрет в env орка).

Шаг 2. Паспорт проекта — CLAUDE.md в корне репо

  • TL;DR, стек, команды (тесты/запуск/деплой), среды (prod/staging), структура.
  • Раздел «Артефакты задачи» — точные имена (00-business-request..15-staging-log, 04-test-plan.YAML).
  • Раздел «Конвенции» (commits, ветки, ADR-формат).
  • Раздел «Правила для агентов» (golden source, не править чужие артефакты, не закрывать задачу, машинные вердикты — YAML).
  • Если есть инфра-риски (self-hosting/shared resources) — отдельный раздел + docs/operations/INFRA.md.

Шаг 3. Структура документации (канон)

  • docs/architecture/README.md — обзор + конвейер + QG-таблица.
  • docs/architecture/adr/ — сквозные ADR (adr-NNNN-slug.md) + README.md индекс.
  • docs/work-items/ — артефакты задач (по <plane-id>).
  • docs/operations/ — runbook/инфра (если нужно).
  • docs/history/ — архив (bugfixes, lessons, incidents).
  • CHANGELOG.md (Keep a Changelog).

Шаг 4. Промпты агентов — .openclaw/agents/*.md

  • Все 6 ролей: analyst, architect, developer, reviewer, tester, deployer.
  • По каркасу из principles/PROMPT_PRINCIPLES.md, содержимое — СВОЁ под проект.
  • Каждый ссылается на CLAUDE.md + docs/architecture/README.md.
  • Модели сверены с орк src/agents/launcher.py AGENT_CONFIGS.
  • reviewer содержит reviewer-gate на документацию (REQUEST_CHANGES при необновлённой доке).

Шаг 5. Проверка готовности

  • Тестовая задача в Plane → проходит весь конвейер до done.
  • Вебхук фильтрует чужие проекты (unknown → ignored).
  • Артефакты пишутся в docs/work-items/<id>/ с правильными именами.
  • Quality Gates читают машинные вердикты (verdict:/deploy_status:/staging_status:).

Образец готового набора — examples/enduro-trails/. Принципы промптов — principles/PROMPT_PRINCIPLES.md.