提交代码时 git commit message 是不是写的详细点比较好?

2021-08-06 09:58:45 +08:00
 polyang

最近我无意中注意到同事代码时 commit message 写的是“1”、“111”、“。。。。”这种无意义的 message,就是下面这种:

进而联想到,我们在开发时,commit message 是不是写的详细一点比较好?

7005 次点击
所在节点    程序员
72 条回复
AoEiuV020
2021-08-06 10:00:44 +08:00
不说多详细,起码要有一行文字看完大概知道这个 commit 是做了什么,
Tianao
2021-08-06 10:01:43 +08:00
废话,肯定是要详细。这种写也可能是 commit 粒度太细了,没有耐心写。
zinete
2021-08-06 10:05:14 +08:00
git hooks 整个代码提交规范
Morriaty
2021-08-06 10:06:18 +08:00
Kusoku
2021-08-06 10:06:45 +08:00
不用很详细,但是需要清晰和一定概括性,详细的信息应该附在代码中作为注释
Shook
2021-08-06 10:07:21 +08:00
起码要说一下这个 commit 是做什么的吧
huangmingyou
2021-08-06 10:07:47 +08:00
理论上肯定要写清楚,并且作为开发规范。
q2551430130
2021-08-06 10:08:10 +08:00
当然
deplivesb
2021-08-06 10:11:35 +08:00
也不能是 800 字的作文吧,但至少要让别人能知道你这是这个 commit 干了啥
zhangchongjie
2021-08-06 10:13:41 +08:00
这是基本的东西吧,每一次提交的大概变动,先不说为了团队,自己以后 debug 的时候也好看,回滚方便
yolee599
2021-08-06 10:18:18 +08:00
我一般都是建好仓库后建一个模板文件:.gitmessage,然后执行 git config commit.template .gitmessage,之后提交的时候执行 git commit 就会自动引用模板,在相应的位置填写信息就可以了,禁止使用 git commit -m 。模板参照这个: https://github.com/angular/angular/blob/master/CONTRIBUTING.md
polyang
2021-08-06 10:21:00 +08:00
@yolee599 感谢,我去看看
ch2
2021-08-06 10:26:19 +08:00
一句话说清楚
chengxynds
2021-08-06 10:38:47 +08:00
知道干了啥就行 业务+动作
xwayway
2021-08-06 10:42:30 +08:00
我们 commit message 有需求的一般需要贴上 jira 链接,然后大致写下实现了什么。如果是修改 bug,要说下改动点,影响范围什么的
gowk
2021-08-06 10:47:01 +08:00
pengtdyd
2021-08-06 10:53:54 +08:00
@yolee599 Angular 扎心了,用的人少,却因为 git commit 规范被提及。
whorusq
2021-08-06 11:03:25 +08:00
[bug 号|需求号|其它] 模块名 > 功能名:然后简单描述本次提交做了什么工作
我们一般这么写,仅供参考
0312birdzhang
2021-08-06 11:28:13 +08:00
看一下 linux 的提交记录,详细到飞起
violetlai
2021-08-06 11:45:44 +08:00
IDE 基本都有 git commite template 插件吧 照着模版填就好了

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/794004

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX