Skip to content

PR 规范

Jump to bottom
zombieJ edited this page Dec 29, 2018 · 5 revisions

Ant Design 新特性提交规范

[English version]

  1. 此规范适用于 ant-design 和 ant-design-pro。
  2. 和现在一样的约定，所有 新特性 必须提交到 feature 分支。
  3. 新特性 指那些新功能增加，UI 的明显变化，交互上的改进，底层重构等变更。
  4. feature 分支将会锁定，不允许直接提交，所有变动需要发送 Pull Request。
  5. 按下列 PR 模板提交特性的相关信息。
  6. 保证 CI 和各类校验工具通过。
  7. 变动必须附带相应的 changelog，将改动如实反馈给用户，也方便后续发布的同学查阅。
  8. 需要得到至少另一个维护者的接受才能合并。
  9. 日常 bugfix、文档、站点改进、分支合并等不在此规范约束范围内（但是仍需要通过 PR 形式提交一遍追踪变更）。
  10. 此规范用于限制 Ant Design 官方维护者，其他成员提交 PR 时可以自行选择是否使用模板。

Pull Request 模板

### 这个变动的性质是

- [x] 新特性提交
- [ ] 其他改动（日常 bugfix、文档、站点改进、分支合并等，不需要填写余下的模板）

### 需求背景
  
> 1. 描述相关需求的来源。
> 2. 要解决的问题。
> 3. 相关的 issue 讨论链接。
  
### 实现方案和 API
  
> 1. 基本的解决思路和其他可选方案。
> 2. 列出最终的 API 实现和用法。
> 3. 涉及UI/交互变动需要有截图或 GIF。
  
### 对用户的影响和可能的风险

> 1. 这个改动对用户端是否有影响？影响的方面有哪些？
> 2. 预期的 changelog 要怎么写？
> 3. 是否有可能隐含的 break change 和其他风险？

### 请求合并前的自查清单

- [x] 文档已补充或无须补充
- [x] 代码演示已提供或无须提供
- [x] TypeScript 定义已补充或无须补充
- [x] Changelog 已提供或无须提供

### 后续计划

> 如果这个提交后面还有相关的其他提交和跟进信息，可以写在这里。

范例：https://github.com/ant-design/ant-design/pull/14003

Homepage

Clone this wiki locally