请停止编写糟糕的提交消息!
武培轩 人气:2我想大家都有过这样的经历:
你正在开发一个项目,它使用 Git 进行版本控制。
你刚刚完成更改,并且想要快速更新分支。
因此,你打开了终端,并通过一些快速命令,使用所做的更改来更新远程分支。
git add .
git commit -m "added new feature"
git push
但是随后你进行了一些测试,发现你的代码中存在 bug。
不用担心,你可以快速找到解决方案,并再次提交以解决该问题。
git add .
git commit -m "fix bug"
git push
你重复此过程几次,现在最终得到一个 git commit 日志,如下所示:
目前,这对你来说似乎还不错,毕竟,你目前正在处理该部分代码,即使提交的信息不能传达你更改的意图,你仍然可以轻松地解释进行了哪些处理。
问题
几个月过去了,现在,另一个开发人员正在回顾你所做的更改。
他们试图理解你所做更改的细节,但是由于你提交的消息不是描述性的,因此他们无法获取任何信息。
然后,他们尝试去查看每个提交的差异。但是,即使这样做了,他们仍然无法确定你在实现中选择的背后的思考过程。
因此他们可以使用 git blame
找出是谁进行了这些更改,并开始向你询问有关实现的问题。
但是,由于时间已经过去很久了,所以你不会记得太多。你通过提交进行检查,而你不再记得该项目中执行决策背后的逻辑。
最终,你在微信上向同事发送了悲伤的表情符号
加载全部内容
- 猜你喜欢
- 用户评论