Git使用-commit信息怎么写

2024/05/19 | 字数876 | 阅读2分钟


用途

Git Commit消息的原始用途是给每次修改增加一个说明信息,让程序员知道修改的意图和内容。除了这个,Commit消息当然也可以用作它用,这里我们就举两个例子:

当然,实现上面的两个功能,对消息的格式是有要求的,这里做一个汇总:

  1. 增加前缀,表示修改意图:
    • feature: 表示这是一个新特性的提交
    • fix: 表示修改了一个问题
    • doc: 表示和文档相关的提交
    • test: 表示增加测试用例或者修改测试代码
    • style: 表示修改代码风格
    • refactor: 表示对代码重构
  2. 与问题跟踪系统联动
    • fix: #NNNN 这里要求以fix: 开头,同时以#NNNN表示问题单号

上面第1条,关于前缀,如果没有,就表示一次普通的提交,这样比较灵活,毕竟不是每次提交对与最终产品都有重要价值。

原则

除了上面这些规则,最主要的还是消息的内容。这里有两条简单的原则供大家参考:

消息模版

git提供了消息模版的机制,可以用来初始化commit信息,但实际使用起来看,并不算理想。但在项目初期,为了规范项目成员提交信息,提供一个参考还是可以的。方法如下:

.gitmessage文件的内容可以参考下面这个:

txt
1
2
3
4
5
6
7
8
# feature: new feature avaliable
# fix: [#NNN] fix a bug
# doc: docs for new support
# style: change code style
# test: new test cases or fix a test failure.
# refactor: refactor framework
# build: build script or build bugfix
# nothing special, so NO prefix for this commit

这个模版的内容以#开头,表示这是注释,不会体现在最终的提交信息中,仅起到提示的作用。另外最后一行中,没有任何前缀,不属于上面的任何一类,表示不需要特别关注。上面的分类也是小编的个人意见,不是标准,可以根据项目的需要自行定制。

上一篇:Git使用-利用钩子实现自动化 下一篇:Git建议-代码库里放什么

【文章不错,鼓励一下】