ddmitry/clickstream-ch-kafka-superset-demo

Files

T

ddadmin aecbf392d9 docs(agents): подключена doc/issue-методология Pocock и зафиксирована раскладка

- Зачем:
  - развести документацию по времени жизни: транзиентные спеки отдельно от
    долговечных решений (ADR) и доменного словаря (CONTEXT.md), вместо одного
    громоздкого spec-документа.
- Что:
  - добавлен блок Agent skills в AGENTS.md (issue tracker / triage / domain docs).
  - созданы docs/agents/{issue-tracker,triage-labels,domain}.md: локальный
    markdown-трекер в .scratch/, дефолтные triage-метки, single-context раскладка.
  - зафиксировано решение как docs/adr/0001-spec-adr-issue-layout.md.
- Проверка:
  - git show --stat HEAD; прочитать AGENTS.md и docs/adr/0001-spec-adr-issue-layout.md.

2026-06-01 23:29:50 +03:00

4.0 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-планы (использовать как исторический контекст, не как источник истины).

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

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

4.0 KiB Raw Blame History