ddmitry/clickstream-ch-kafka-superset-demo

Files

T

ddadmin 18a55dd640 docs(adr): спеки в docs/specs, handoff'ы в .scratch/handoffs

- Зачем:
  - воркфлоу эволюционировал: design-спекам нужен durable-дом, а handoff'ам —
    стабильное место вместо эфемерного /tmp.
- Что:
  - ADR-0002: design-спеки переезжают в docs/specs/YYYY-MM-DD-*.md (superseding ADR-0001).
  - ADR-0003: handoff'ы — одноразовые леса́ в .scratch/handoffs/, коммитятся, уборка best-effort.
  - ADR-0001 помечен как частично заменённый; AGENTS.md описывает место handoff'ов.
- Проверка:
  - docs/adr/000{1,2,3} согласованы, перекрёстные ссылки рабочие.

2026-06-06 16:12:10 +03:00

4.3 KiB

Raw Blame History

AGENTS.md

Короткий контракт для работы в репозитории мини-демо DWH кликстрима.

Цель репозитория

Реализовать тестовое задание DE: поднять в docker compose стек Kafka + ClickHouse + Airflow + Superset + Prometheus/Grafana и получить витрины для первичного анализа.

Обязательные правила

Данные

Не загружать *.jsonl целиком без необходимости: по умолчанию использовать малый срез (head -n 20..50).
Для демо и тестов важнее быстрый и повторяемый прогон, чем полнота данных.
"Грязные" записи не должны валить пайплайн: ошибки парсинга фиксируются в ODS.

Изменения в коде

Изменения держать минимальными и в скоупе задания (инфра, ingest, трансформации, витрины, мониторинг).
Не коммитить секреты. Использовать .env и .env.example.
При изменении инфраструктуры или DDL обновлять документацию в этом же PR.
Комментарии в SQL и Bash писать на русском языке.

Проверка API через MCP Context7 (обязательно)

Для спорных или меняющихся API (особенно Airflow/operators/providers) сначала уточнять актуальную версию через MCP Context7.
Минимальный порядок: resolve-library-id -> query-docs.
Принятое решение фиксировать в коде и/или документации (кратко: что проверили и почему выбрали именно этот вариант).

Agent skills

Конфигурация для инженерных скиллов (набор Matt Pocock). Подробности — в docs/agents/.

Issue tracker

Локальный markdown: задачи и PRD живут файлами в .scratch/<feature>/ (коммитятся, .scratch/ не в .gitignore). GitHub Issues не используются. См. docs/agents/issue-tracker.md.

Triage labels

Пять канонических ролей, строки совпадают с именами (needs-triage, needs-info, ready-for-agent, ready-for-human, wontfix). См. docs/agents/triage-labels.md.

Domain docs

Single-context: CONTEXT.md и docs/adr/ в корне репозитория. См. docs/agents/domain.md.

Навигация по документации

README.md — пользовательский quick start и обзор.
docs/REPO_MAP.md — карта исполняемых артефактов и где что менять.
docs/OPERATIONS.md — запуск, DAG-параметры, проверки и troubleshooting.
docs/ARCHITECTURE.md — детали по слоям STG/ODS/DDS/DM.
docs/COMMIT_RULES.md — правила оформления коммитов.
docs/course/ — продвинутый учебный курс «со звёздочкой» на базе стенда (PRD, план обучения, стандарт уроков); начинать с docs/course/README.md.
plans/ — legacy-планы (использовать как исторический контекст, не как источник истины).
.scratch/handoffs/YYYY-MM-DD-<slug>.md — handoff'ы для продолжения работы в новой сессии (одноразовые, коммитятся, уборка best-effort; скилл handoff пишет сюда). См. docs/adr/0003-handoffs-in-scratch.md.

Ограничения по структуре

Новые документы создавать в docs/ (или в профильных подпапках), не в корне репозитория.

4.3 KiB Raw Blame History