提交艺术：编写规范的Commit Message与创建高质量的Pull Request

提交艺术：编写规范的Commit Message与创建高质量的Pull Request

从一次痛苦的代码回溯说起

上周排查一个线上闪退问题，git log 拉出来一看，满屏的“fix bug”“update”“优化代码”这类提交信息。为了定位引入问题的变更，我们不得不逐个点开提交看diff，花了近两个小时才找到那行被误删的边界检查。团队里一位新人小声问：“能不能让提交信息说得更明白点？”——这个问题提得好，今天我们就聊聊怎么把提交这件事做出专业感。

Commit Message：不只是给机器看的日志

很多人把提交信息当成流水账，随手写几个字了事。但规范的Commit Message其实是项目的重要文档，它能让团队协作效率提升一个档次。看看下面两种写法：

别这样写：

fix bug

试试这样：

fix(device-driver): correct buffer overflow in serial_read() The buffer size check was using '>' instead of '>=', causing one-byte overflow when buffer is full. Closes #123

看出区别了吗？好的提交信息自带上下文，三个月后你再看