Перейти к содержанию

Разработка проекта

Раздел для тех, кто развивает саму подсистему — исправляет баги, добавляет функциональность, расширяет API.

Кому это не нужно

Если вы подключаете адаптер в своё прикладное решение и пишете обработчики — вам хватит раздела Пользователю. Эта секция — для разработчиков самой подсистемы.

С чего начать разработку адаптера

Маршрут «с нуля до первого PR»:

  1. Найдите или заведите задачу. Задачи проекта живут в репозитории kfk-tasks, ход работ — на доске GitHub Projects. Для значимого изменения сначала обсудите его в issue — см. Участие в разработке.
  2. Клонируйте репозитории: адаптер (исходники в src/, формат EDT) и базовый проект (информационная база для разработки). Полная карта репозиториев — Репозитории.
  3. Разверните окружение — платформа, EDT, Kafka в Docker: Окружение. Скрипты развёртывания — в kafka-tools.
  4. Откройте оба проекта в EDT и разверните базовый проект на информационной базе; адаптер подключается к нему как библиотека.
  5. Разберитесь, где что лежит: публичный API и внутренние модули — Архитектура модулей; справочники, регистры, перечисления — Объекты метаданных; управляющие константы — Константы.
  6. Проверьте изменение: примеры использования API — в тестовом расширении; юнит- и UI-тесты — см. Тестирование.
  7. Оформите pull request по правилам из Участия в разработке.