变更记录

  • date: changelog

状态

DRAFT | PROPOSED 未实现
请查看 PROCESS 页面。 如果 ADR 处于草稿阶段(草稿 PR),请使用 DRAFT;如果 ADR 正在评审中,请使用 PROPOSED。

摘要

“如果你无法简单地解释它,那说明你还没有足够理解它。” 请提供对该 ADR 的简化说明,使非专业读者也能理解。 用简短的(约 200 字)描述说明正在解决的问题。

背景

本节包含理解当前状态及其为何构成问题所需的全部背景信息。 应尽可能简洁,并介绍解决方案背后的高层思路。 本节的语言应保持价值中立,只陈述事实。

决策

本节说明所提议解决方案的全部细节,包括实现细节。 还应描述作为本次变更一部分,可能需要调整的影响项 / 关联项。 如果拟议的变更规模较大,也请说明一种便于评审的实施方式。 (例如:如何将工作最佳地拆分到多个独立 PR 中)

结果

本节描述应用该决策后的结果。 所有结果都应在此总结,而不仅仅是“正面”的结果。

正面

positive consequences

负面

negative consequences

中性

neutral consequences

参考资料

是否有相关的 PR 评论、促成此次决策的问题,或支撑该设计选择的参考文章?如果有,请在此链接!
  • reference link



Changelog

  • date: changelog

Status

DRAFT | PROPOSED Not Implemented
Please have a look at the PROCESS page. Use DRAFT if the ADR is in a draft stage (draft PR) or PROPOSED if it’s in review.

Abstract

“If you can’t explain it simply, you don’t understand it well enough.” Provide a simplified and layman-accessible explanation of the ADR. A short (~200 word) description of the issue being addressed.

Context

This section contains all the context one needs to understand the current state, and why there is a problem. It should be as succinct as possible and introduce the high level idea behind the solution. The language in this section is value-neutral. It is simply describing facts.

Decision

This section explains all of the details of the proposed solution, including implementation details. It should also describe affects / corollary items that may need to be changed as a part of this. If the proposed change will be large, please also indicate a way to do the change to maximize ease of review. (e.g. the optimal split of things to do between separate PR’s)

Consequences

This section describes the consequences, after applying the decision. All consequences should be summarized here, not just the “positive” ones.

Positive

positive consequences

Negative

negative consequences

Neutral

neutral consequences

References

Are there any relevant PR comments, issues that led up to this, or articles referenced for why we made the given design choice? If so link them here!
  • reference link