How to Write Useful Commit Messages
a day ago
- 有效的提交信息能简化代码审查、向团队和用户传达变更、辅助未来调试，并为开发工具提供数据。
- 采用“倒金字塔”结构组织提交信息，将最关键信息放在最前面，长信息可使用标题。
- 提交标题应描述变更的效果（“做了什么”），而正文必须清晰解释动机（“为什么”）以及它如何影响用户。
- 通过交叉引用问题和缺陷、总结外部参考、证明新依赖的合理性来提供必要背景。
- 记录学习心得、考虑过的替代方案、测试说明和限制，以及可搜索的工件（如特定错误消息）。
- 突出破坏性变更，用截图/视频补充UI变更，并将吐槽或故事放在信息的最末尾。
- 省略代码差异中显而易见的信息、短暂的审查讨论，以及应直接记录在代码中的关键维护细节。