закрыта задача config-example-toml
This commit is contained in:
@@ -1,45 +0,0 @@
|
||||
# 🧹 Переименовать образец конфига в config.example.toml
|
||||
|
||||
- **Тип:** chore
|
||||
- **Категория:** Очередь — Поднято наверх: шесть задач ниже правят конфиг и каждая допишет старое имя образца, удлиняя перечень мест переименования.
|
||||
- **Зачем:** Конвенция называет config.dist.toml объявленным расхождением, но тут же пишет это имя как правило — документ противоречит сам себе, а образец расходится с конвенцией.
|
||||
|
||||
Конвенция конфигурации взята из проекта jellybit и **сама называет сегодняшнее
|
||||
имя расхождением**: `docs/conventions/config.md`, строка 7 — «образец называется
|
||||
`config.dist.toml`, а не `config.example.toml`». Но строки 31 и 34 того же
|
||||
документа пишут `config.dist.toml` как правило, с заголовком раздела и всем
|
||||
прочим. Документ противоречит сам себе, и который из двух читать — не выводится.
|
||||
|
||||
Задача закрывает расхождение в пользу конвенции: файл переименовывается, а
|
||||
документ перестаёт спорить сам с собой.
|
||||
|
||||
## Затрагивает
|
||||
|
||||
- `config.dist.toml` в корне — переименование;
|
||||
- `docs/conventions/config.md` — строка расхождения, заголовок раздела и все
|
||||
упоминания имени;
|
||||
- `CLAUDE.md`, раздел «Команды» — строка про то, что копировать;
|
||||
- `README.md` — команда `cp` и абзац про недостающий ключ;
|
||||
- `docs/review.md`, «Триггеры метки» — упоминание образца;
|
||||
- `docs/conventions/README.md` — строка про самодокументируемый образец;
|
||||
- `tasks/items/external-call-timeouts.md`, `telegram-account-link.md`,
|
||||
`oidc-login.md` — разделы «Затрагивает» ссылаются на имя.
|
||||
|
||||
## Критерии приёмки
|
||||
|
||||
- Имени `config.dist.toml` в репозитории не осталось. Оракул —
|
||||
`grep -rn 'config\.dist\.toml' . --exclude-dir=.git` пуст.
|
||||
- Образец лежит под именем `config.example.toml` и по-прежнему не даёт
|
||||
закоммитить реальный конфиг. Оракул — `git ls-files config.example.toml`
|
||||
отдаёт файл, `git check-ignore config.toml` отдаёт `config.toml`.
|
||||
- Конвенция больше не называет имя образца расхождением. Оракул —
|
||||
`grep -n 'config\.example\.toml' docs/conventions/config.md` не находит строки,
|
||||
противопоставляющей одно имя другому (сегодня это строка 7).
|
||||
- Гейт зелёный: битых ссылок правка не оставила. Оракул — `task docs`.
|
||||
|
||||
## Рамки
|
||||
|
||||
Состав полей образца и его комментарии не пересматриваются — задача про имя и
|
||||
про ссылки на него. Прорехи образца, помеченные в конвенции строками
|
||||
«*Расхождение:*», остаются на месте.
|
||||
|
||||
Reference in New Issue
Block a user