Change language

Как добавить модуль

Порядок одинаков для базовой платформы и для продуктового слоя.

  1. Создайте директорию по соглашению: modules/microservices/<домен>/ms-<имя> для сервиса, modules/microfrontends/<домен>/mf-<имя> для экрана, modules/workflows/wf-<имя> для процесса.
  2. Опишите контракт в modules/types/<домен>/ и сгенерируйте клиентов: bun run gen. Клиент появится как пакет g-<имя> и станет доступен из браузера, из другого процесса на шине и изнутри workflow.
  3. Напишите README с разделами ## Purpose и разделом о границе ответственности. Первые абзацы этих разделов попадут в реестр на сайте — пишите их для читателя, а не для себя.
  4. Включите модуль в решение, если он поставляется не в одиночку: добавьте короткое имя в modules/solutions/solutions.json и объявите зависимости.
  5. Пересоберите документацию: bun run docs в core/tools/docs. Модуль появится в реестре, счётчики на странице экосистемы пересчитаются сами.

Чего делать не нужно: править списки модулей в данных сайта, дублировать описание в лендинге, регистрировать модуль где-то ещё. Генерация односторонняя — из исходников в данные, и никогда обратно. Всё, что лежит в data/, при следующей сборке будет перезаписано.

Требования к модулю на ревью: он не ходит в чужие хранилища, не обходит шину прямыми вызовами, объявляет только те разрешения, которыми пользуется, и не расширяет свою зону ответственности молча.