Pull Request 规范

概述

Pull Request（以下用pr代称） 需要严格遵循以下原则**：

• 一个 pr 只围绕一件事
• 避免过大的 pr
• 尽量不要重新格式化代码

一个 pr 只围绕一件事

一个 pr 应该只负责一件事，这遵循设计模式中的单一职责原则

如何定义一件事：

• 处理了一个 issue
• 解决了一个bug
• 新增了一个组件或功能
• 重构代码实现了某一个目的

一个 pr 可以包含多个 commit，但要注意尺度，保证 pr 不要过大

避免过大的 pr

该条规则对于新增组件的 pr 例外

一个 pr 的文件改变最好少于12个文件（排除build产生的文件）

尽量不要重新格式化代码

在对代码进行修改时，如果遇到和自己代码风格不一致的代码，尽量不要去重新格式化。

因为重新格式化后，差异对比工具会显示格式化后的所有代码均为修改的代码，审查者无法清楚的查看到你修改的部分。

信息填写

Title

因为一个 pr 可能包含多个 commit，所以 title 格式不再采用 commit 的格式。

主要格式：[名词]+动词+名词+[形容词]+[名词]

例如：

• 修复 Collapse 组件无法展开的问题
• Collapse 组件新增 top 属性
• 新增 Message 组件
• 删除 Message 组件 color 属性
• 修改 Message 组件 top 属性单位为 rpx

注意英文单词左右添加一个空格方便阅读

Content

如果 title 已经描述清楚了此次 pr 的目的，则 Content 可以留空，否则应该对此次 pr 进行详细的描述

其他规则

连接 issue

如果这个 pr 解决了某个 issue 提出的 bug 或者 feature，则应在 pr 中将此 issue 关联起来

关联 issue 的好处：

• 可以在 issue 界面快速跳转到这个 pr，查看修复的情况
• 在该 pr 被合并进 master 分支后，对应 issue 会被自动 close。所以连接了 pr 的 issue 不需要手动 close