ADR 0218 — 每个 ADR 都命名为“ADR NNNN — 标题”
状态
已接受。 2026-10-15(AT-559,所有者 10月15日的决定):只在标题上统一 ADR 的命名。
主题:docs。补充(而不编辑)索引的约定(0202)。
背景
docs/adr/ 中的 213 个 ADR 里,82 个以 # ADR NNNN — … 开头,131 个以
# NNNN — … 开头。两种形式并存而没有规则,写新 ADR 的人照抄相邻的那个。
标题会出现在浏览器标签页、站点的本地搜索和侧边栏中;只有编号说明不了这一页是 ADR。
决策
- 每个 ADR 的标题(H1)是
ADR NNNN — <标题>:ADR前缀、4 位编号和破折号—。 - 文件名保持
NNNN-<slug>.md,现有的 slug 保持原样,无论是什么语言:文件名就是发布的 URL,重命名会破坏外部链接。 - 在已接受的 ADR 中把
# NNNN —换成# ADR NNNN —是对标签的机械规范化,不是编辑 决策。“已接受的 ADR 永不编辑”的规则对内容继续有效:背景、决策、后果和标题文字保持不变。 website/i18n/<locale>/下的翻译加上同样的前缀;翻译后的标题文字保留。docs:check(scripts/docs/temas-de-adr.mjs)拒绝 H1 不以# ADR NNNN —开头、或编号 与文件不一致的 ADR。
后果
- 只有一种形式,并且有检查:下一个 ADR 不再在两种之间选择。
- 这次修改在同一个提交里触及 131 个源文件和翻译副本;原本是最新的副本,其
traducao_de:在下一个提交中更新,这样一致性报告不会报告不存在的过时。 - slug 继续混用语言(旧的用英语
short-title,新的用 pt-BR)。这是可以接受的:URL 比统一更重要。