你们都怎么写 Git 的提交消息?

2019-08-02 17:16:07 +08:00
 WangLiCha

公司有打算使用 Git 作为代码管理工具,管理员的想法是每次 commit 的时候提交人能写上详细的提交信息,大概像这样:

提交类型:bug 修复

修改内容:修复 XXXXXX 的 bug

修改结果:当 XXXX 时,不再出现 XXXX 的 bug

我感觉这个提交信息有些过长了……毕竟 GitHub 上的项目都是一行能写完的,然后我们用的 Gogs 的 web 端上默认只显示第一行,但是管理员认为不写这么详细就不便于做质量追溯,而且如果是想单独提交一份更新日志的话无法监督更新日志的内容。

总之就是,我感觉自己的使用习惯跟管理员都想法挺多矛盾,不知道你们是怎么进行这方面的管理的?

5358 次点击
所在节点    问与答
50 条回复
windsage
2019-08-02 23:12:23 +08:00
直接有模板的,根据 issue 或者问题单号填
msg7086
2019-08-02 23:13:43 +08:00
模块,提交类型,简要说明

详细说明(可选)

module1: Fix #12345, XYZ is no longer XYZ

XYZ is fixed as ABC.
fyibmsd
2019-08-03 09:17:51 +08:00
alias push="git add . && git commit -m update && ggpush"
meow33
2019-08-03 09:46:09 +08:00
没错,我就喜欢 update,反正自己一个人看,还在前期开发阶段
darrenfang
2019-08-03 09:49:42 +08:00
@tankren #7 去看看交易区
ZXCDFGTYU
2019-08-03 11:42:45 +08:00
新增了代码或者文件:
Added:
1. xxxx

修改了代码或者文件(包括删除代码,但不包括删除文件):
Modified:
1. xxxx

删除了文件:
Removed:
1. xxxx

修复了某个 Bug:
Fixed:
1. xxxx (内容格式:修复了因 xxxx (错误原因)导致的 yyyy (错误表现) bug。#issue:1123 (如果有 issue ))

每一项都说明清楚了自己干了啥就行。

这是我个人的习惯。
LxExExl
2019-08-03 12:30:04 +08:00
格式不重要 但如果不知所云 要么没人给 review 要么直接打回来重写
HGladIator
2019-08-03 13:58:57 +08:00
我定了 git commit message 标准, 但是没人用,我就自暴自弃用 `git commit --allow-empty-message --no-edit `
我建议是找 GitHub 热门项目看看别人是怎么写的,跟着学就好了
romisanic
2019-08-03 14:07:25 +08:00
有时候提交的是本次处理完成的事儿
有时候提交的是本次提交时候的进度
有时候就是一个 bug fix
有时候甚至就一个_
而领导同事们经常只是一个 save
Antidictator
2019-08-03 16:20:50 +08:00
@tankren 如果没记错的话,是二手节点开始使用的

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

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

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

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

© 2021 V2EX