Code Review

Commit Message

格式要求：

${scope}: ${subject}
//注意空行
${description}

• ${scope}：必需，一般是项目目录、模块或组件的名字，用来描述本次commit的影响范围。
  • 使用小驼峰格式。
  • 嵌套层级使用 / 表示。
  • 涉及多个目录可以使用 , 分隔。
  • 无意义的层级应该省略。
  • 使用 base 表示基础结构、框架相关的改动，用 misc 表示杂项改动，用 all 表示大范围重构。
• ${subject}：必需，描述干什么和为什么。
  • 80个字符以内的简要说明，首字母小写，祈使句，不加句号。
  • 不要写废话，要具体到改了什么。
• ${description}：可选，详细说明。

流程

• 提交者发起 MR，assign 给同级同事：
  • 代码变动要尽量小且专注于一个任务，不要攒的很大或者是多个任务。
  • 需要一次性提交大量不需要 review 的文件的分两次 commit，不需要review的放在第一个 commit。
  • 如果冲突由提交者 merge 或 rebase。
• 审查者 review 代码：
  • 对各项要求进行检查，有疑问的地方留评论。
  • 如果提交者已经对之前的评论做出了修复，审查者需要确认后 resolve thread。
  • review 完成后 assign 给提交者处理。
• 提交者响应评论：
  • 确实有问题的进行修复，检查其他地方是否还有类似问题一并修改。
  • 不同意的可以讨论。
  • 完成后 assign 给审查者再次 review，不需要额外留评论。
• 审查无误后，将 MR assign 给 Leader 或项目维护者进行二次 review 合并。