Sahara/GitCommits

本文档是一个简短的教程，包含提交到 Sahara 的要求和技巧。

Git 提交良好实践

• 每个提交包含一个“逻辑变更”
  • 不要将空白/重构变更与功能代码变更混合在一起；
  • 不要将两个不相关的功能变更（或功能变更与空白/重构变更）混合在一起；
  • 不要在一个巨大的提交中发送大型新功能；

• 变更请求主题（提交消息的第一行）
  • 它应该以大写字母开头；
  • 避免在主题中使用冒号（请记住，它将以以下形式显示：“Change I1de3f893: 验证的单元测试重构”）；
  • 避免尾随标点符号；
  • 它应该与提交消息的其余部分用空行分隔；

• 在提交消息中指定相应的 Launchpad bug 和蓝图
  • bug 应该以每行一个的形式指定，格式如下：“Closes-Bug: #123456” 或 “Partial-Bug: #123456”；
  • 蓝图应该在蓝图之后，每行一个的形式指定，格式如下：“Implements: 蓝图名称” 或 “Partially implements: 蓝图名称”；

• 使提交消息清晰
  • “Change-Id: IXXX” 应该是最后一行，并与消息的其余部分用空行分隔；
  • 在 bug/蓝图之前和之后用空行分隔；

• 提交消息中的信息
  • 提交消息必须包含充分理解和审查补丁正确性所需的所有信息；少不是多；多才是多；
  • 不要假设审查者了解原始问题是什么；
  • 不要假设审查者可以访问外部网络服务/站点；
  • 不要假设代码是自解释/自文档化的；
  • 描述进行变更的原因；
  • 阅读提交消息，看看它是否暗示了改进的代码结构；
  • 确保有足够的信息来决定是否进行审查；
  • 第一行提交信息是最重要的；
  • 描述当前代码的任何限制。

良好的提交消息示例

待定