RFC Template

246 阅读2分钟
  • 开始时间:(填入创建日期:YYYY-MM-DD)
  • 当前状态:(可选:评审中、进行中、已实现、已废弃、草稿)
  • 关联 MR:(填上 AntCode MR)

背景

关于本 RRC 的历史背景,让评审人能够快速地进入上下文。

术语

若本 RFC 涉及到一些专业术语,需要对此进行解释:

名称含义
xxxxxxxxxxxx

若本 MR 不存在此节,可手动删除。

动机 / 目标

我们为什么这样做?

能够解决什么问题?

期望达到什么结果?

请重点说明动机,否则不接受此 RFC。

Tip:发布 RFC 前请移除此段、动机和目标请二选一。

方案设计

RFC 的主体部分,需要详细说明(流程图、交互图等),帮助开发组成员了解并实施。

任何新增的术语请在这里定义。

Tip:发布 RFC 前请移除此段。

方案概述

适合方案的综述。

用户视角

面向用户:考虑本 RFC 最终呈现给用户的形态:

  1. 若是新特性:怎么用;
  2. 若是 Breaking:怎么平滑升级和迁移;

公共视角

同时面向用户和核心开发者都需要阅读的内容:

  1. API 设计;
  2. 常见用法;

技术视角

面向核心开发团队:描述此 RFC 的技术实现(此部分对于普通用户不需要阅读):

  1. 方案的技术设计细节;
  2. 涉及的系统改动;
  3. 流程图/系统交互图;
  4. 边界场景处理;

缺点

为什么不这么做?本技术方案、交互设计带来的副作用是什么?

备选方案

还考虑了哪些其他设计?不选择他们的原因是什么?

未解决的问题

是否存在还没有解决的问题,考虑未来如何应对。

Refs

本 RFC 中涉及的重要引用文档。