有时候,想看一下上周代码的提交情况,git log 看时一脸懵,这都提交了写什么?commit 的文字说明跟没写一样,完全不知道提交的功能是什么。
所以,要好好规范一下commit message的格式:
一定要主题鲜明:标题+内容详情+结尾
<type>(<scope>): <subject> <空行> <body> <空行> <footer>
Type:feature、fix(修补bug)、docs、style(格式,即不影响代码的运行变动)、refactor(重构)、test、chore(构建过程或辅助工具的变化)
scope:说明本次commit改动影响的范围,即修改涉及的部分,简要说明。
subject:简要描述本次的改动,以第一人称现在时,以动词开头,首字母不要大写,不写句号
body:具体描述详细修改(前后变化)
footer:放置一些不兼容变更和issue关闭。
还有几点要注意:
- 提交时的粒度是一个小功能点或者一个 bug fix,这样进行恢复等的操作时能够将「误伤」减到最低;
- 不要每提交一次就推送一次,多积攒几个提交后一次性推送,这样可以避免在进行一次提交后发现代码中还有小错误。