Перейти к основному содержимому

ADR 0218 — Каждый ADR называется «ADR NNNN — заголовок»

Статус​

Принят. 2026-10-15 (AT-559, решение владельца от 15.10): унифицировать именование ADR только в заголовке.

Тема: docs. Дополняет, не редактируя, соглашение индекса (0202).

Контекст​

Из 213 ADR в docs/adr/ 82 начинались с # ADR NNNN — …, а 131 — с # NNNN — …. Обе формы сосуществовали без правила, и автор нового ADR копировал форму соседа. Заголовок — это то, что видно во вкладке браузера, в локальном поиске сайта и в боковой панели; один номер не говорит, что страница — это ADR.

Решение​

  1. Заголовок (H1) каждого ADR — ADR NNNN — <заголовок>: префикс ADR, 4-значный номер и длинное тире —.
  2. Имя файла остаётся NNNN-<slug>.md, а существующие slug остаются как есть, на любом языке: имя файла — это опубликованный URL, и его переименование сломало бы внешние ссылки.
  3. Замена # NNNN — на # ADR NNNN — в принятых ADR — механическая нормализация МЕТКИ, а не правка решения. Правило «принятый ADR никогда не редактируется» продолжает действовать для содержания: Контекст, Решение, Последствия и текст заголовка остаются нетронутыми.
  4. Переводы в website/i18n/<locale>/ получают тот же префикс; переведённый текст заголовка остаётся.
  5. docs:check (scripts/docs/temas-de-adr.mjs) отклоняет ADR, чей H1 не начинается с # ADR NNNN — с номером, равным номеру файла.

Последствия​

  • Одна форма, и она проверяется: следующий ADR больше не выбирает между двумя.
  • Изменение затрагивает 131 исходный файл и переведённые копии в одном коммите; traducao_de: копий, которые были актуальны, обновляется в следующем коммите, чтобы паритет не сообщал о несуществующем отставании.
  • Slug по-прежнему смешивают языки (short-title на английском в старых, pt-BR в новых). Это принято: URL важнее единообразия.