exTHmUI Team 规范 2 – Pull Request

发布于 27 天前  127 次阅读


通用

本文档为非内部人员提交贡献必看文档,感谢您的理解。

如果你不知道什么是Pull Request,请自行谷歌/百度或看下面由Github官方提供的文档:

在你的Pull Request中,包含的所有commit message须按照exTHmUI Team 规范 1 – Commit Message中的描述来写,否则exTHmUI Team将不会Merge你的Pull Request。

Pull Request Title

单次Pull Request Title分为两部分:
<库名的书写形式>: <实现功能概括>(<实现功能数量>)[可选]

  1. 若选中的commit只需要实现单一功能/或作单一修改(优化),请用简洁的语言概括。如:
    <repo>: Optimize layout
  2. 若实现功能过多,请用一句话(必须是英语)概括并在括号中注明实现功能数量。详细功能列表写在comment里,如:
    Title:
    <repo>: Improve experience for users(3)
    Comment:
    Improve UI for Button(1/3)
    Dialog -> AlertDialog(2/3)
    example.java: Rebuild code to improve performance(3/3)

Pull Request Comment

我们对Comment的要求并不严格,只有以下两点规范:

  1. 每个功能描述单独成行,补充信息单独成段
  2. 使用标准英语语法

Pull Request Commit 规范

参考文档:
exTHmUI Team 规范 1 – Commit Message

By exTHmUI团队 最后修订于 2020/02/01 18:05


私は世界で最高の自分ではありません。