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

Соглашение об именовании#

Общие ограничения#

  • Допустимые символы:

    • Буквы английского алфавита (a-z)
    • Цифры (0-9), но не в начале названия
    • Подчёркивание (_) для snake_case
    • Дефис (-) для kebab-case

  • Запрещено: 

    Начинать с цифры:         1st_transaction ❌
Использовать спецсимволы: data@field      ❌
Применять пробелы:        user name       ❌
Использовать кириллицу:   пользователь    ❌

Проверка именования:

Репозитории и группы (lower_snake_case)#

  • Если имя содержит верхний регистр или другие разделители:
  • Все буквы приводятся к нижнему регистру
  • Иные разделители заменяются на подчёркивание
  • Пример трансформации: POS.transaction_v2 → pos_transaction_v2

Потоки данных, директории и заголовки (kebab-case)#

  • Используется для:

    • Директорий в репозиториях
    • Поля title в контрактах
    • Поля title в info.yaml файлах

  • Пример:

specification: 1.0.1
title: user-cart
type: object
description: "События в корзине покупателя"

Поля в контрактах (lower_snake_case)#

Примеры корректных названий: event_id, transaction_amount, user_data