Writing commit messages
a day ago
- 专注于传达重要信息和推理过程，而非排版或语法。
- 解释变更的内容和原因，而不仅仅是实现方式。
- 考虑多样化的读者：使用git bisect、git blame的用户、代码审查者以及未来的维护者。
- 采用金字塔写作风格：将最重要的信息放在前面以便快速浏览。
- 包含一个Git风格的主题行，提供简要摘要，后跟空行和详细正文。
- 编写纯文本，段落宽度合理，避免破坏纯文本可读性的Markdown格式。
- 将大型补丁拆分为更小、逻辑清晰的提交，使变更更易于理解。
- 对于开发过程中的临时提交，保持消息简洁；在永久历史中重写它们。
- 清晰标记旧代码与新代码的描述以避免歧义。
- 简洁记录API或行为的变更，并保持代码内文档的更新。