Skip to content
Apothem
Справочник

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

Предписывает имена файлов в kebab-case, формат ключей frontmatter, именование веток с префиксами типа и семантику числовых префиксов для упорядоченных последовательностей артефактов.

Каноничный справочник по форме имён файлов, идентификаторов и имён веток во всей экосистеме. Сводка в CLAUDE.md Соглашения — это встроенное объявление; эта страница — самостоятельный справочник, на который ссылаются нижестоящие участники.


1. Имена в файловой системе

Файлы и папки по умолчанию используют kebab-case. Идентификаторы не содержат пробелов, подчёркиваний и camel-case.

Каноничные исключения в верхнем регистре зарезервированы для синглтонов поверхности публикации, которые каждый участник распознаёт при первом знакомстве: CLAUDE.md, README.md, LICENSE, CHANGELOG.md, SECURITY.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, а также синглтоны набора планов (MASTER-PLAN.md, PROGRESS.md, PHASE.md, SKILL.md, VERSION). Все остальные файлы используют kebab-case.

2. Ключи frontmatter

Ключи YAML-frontmatter используют kebab-case (например, argument-hint, disable-model-invocation). Правило kebab-case применяется единообразно к правилам, командам, делегированным работникам, навыкам и самому CLAUDE.md.

3. Имена веток

Ветки следуют шаблону <type>/<short-description>, где тип берётся из закрытого набора {feat, fix, chore, docs, refactor, test, perf, ci, build, style, revert, release}. Описание — в kebab-case и короче пятидесяти символов.

4. Числовые префиксы

Числовые префиксы (NN-) в путях файловой системы передают порядок и применяются только там, где порядок является неотъемлемым — папки фаз, папки подфаз, скрипты миграции и любой другой класс артефактов, чья последовательность является частью контракта. Синглтоны корневого уровня, не имеющие последовательности соседей, не несут числового префикса; добавление его ошибочно сигнализирует о порядковой связи, которой не существует. Полная дисциплина изложена в src/apothem/rules/canonical-layout.md §2.1.

5. Валидаторы

naming-grep в src/apothem/conformity/naming_grep.py — это поверхность механического принуждения. CI вызывает его через make validate.

On this page