Skip to main content

架构决策记录 (ADR)

有关 ADR、何时编写 ADR 以及为什么编写 ADR 的更多信息,请参见本博文.

记录永远不会被删除,但可以标记为被新决定取代或已废弃。

记录应存放在architecture-decisions目录。

捐款

创建 ADR

  • 复制docs/architecture-decisions/adr000-template.mddocs/architecture-decisions/adr000-my-decision.md(my-decision应该是描述性的。 不要指定ADR编号。) * 按照模板中的指南填写ADR * 提交拉取请求 * 处理并整合来自社区的反馈 * 最终指定一个编号 * 将ADR的路径添加到sidebars.json中的微网站侧边栏 * 将ADR的路径添加到mkdocs.yml * 合并拉取请求

取代替代性争议解决

如果 ADR 取代了旧 ADR,则旧 ADR 的状态会更改为 "被 ADR-XXXX 取代",并链接到新 ADR。