Files
jellybit/docs/conventions/README.md
T

1.2 KiB

Конвенции кода

Кросс-каттинг правила того, как мы пишем код (логирование, ошибки, именование) — в отличие от docs/specs/ и openspec/specs/, которые описывают, что система делает.

Конвенции не переносятся в OpenSpec: это не capability. Короткие инварианты дублируются в CLAUDE.md (агент читает его всегда) и кратко в openspec/config.yamlcontext (подмешивается в генерацию артефактов); детали — здесь. Обоснование «почему» — в docs/adr/.

Записи

  • logging.md — логирование: уровни, поля, что не логируем.
  • config.md — конфигурация: TOML, секреты через деплой (Ansible+Vault), валидация на старте.
  • errors.md — ошибки: stdlib, обёртка %w, errors.Is/As, трансляция на внешней границе.