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

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

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

提交类型:bug 修复

修改内容:修复 XXXXXX 的 bug

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

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

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

5644 次点击
所在节点    问与答
50 条回复
dovme
2019-08-02 17:19:27 +08:00
：bug fixed
learningman
2019-08-02 17:22:19 +08:00
在单独弄个数据库存文本，commit 里放文本的 id ？
YIsion
2019-08-02 17:22:21 +08:00
:bug: fix . bug .
hymxm
2019-08-02 17:22:24 +08:00
不是可以设置模板的嘛
blankme
2019-08-02 17:24:53 +08:00
第一行加个 title，写你想写的简短信息就好了
要看一行还是看完整的都能满足
loshine1992
2019-08-02 17:26:10 +08:00
gitmoji
tankren
2019-08-02 17:28:01 +08:00
请问 v2er 为什么那么喜欢用 迫于？？？？
seon
2019-08-02 17:30:04 +08:00
公司用 gerrit 评审代码，需要按照模板写，大体如下
问题描述
问题编号
问题原因
解决方案
评审人
WangLiCha
2019-08-02 17:32:41 +08:00
@blankme 哇，你这个方法好
Lin0936
2019-08-02 17:33:49 +08:00
一般都会有个 template
pkookp8
2019-08-02 17:34:08 +08:00
bug bugid fixed
feature id commit
Sainnhepark
2019-08-02 17:34:40 +08:00
如果遇到这种情况我会开一个分支，分支里的每一个提交信息都尽量简短，但是合并的时候尽量把 bug 描述清楚
WhoMercy
2019-08-02 17:35:53 +08:00
针对总的任务做一下总结，
有必要的话，再针对修改的文件做一下备注
whitev2
2019-08-02 17:37:20 +08:00
联动 bug 管理系统，提交的时候自动填充进去
zpf124
2019-08-02 17:39:33 +08:00
网络上有很多人都推荐 google 的 Angular 提交格式规范, 不知道其他大公司内部有没有别规范.
https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits


大概是这个格式.

---------------------------

fix(components/tables): change table attribute typo

修改了 xxx 的属性名称拼写错误.
为了解决兼容在接下来的几个版本会依旧保持久的错误写法可用,但会提示警告.
预计 3 个月后彻底移除拼写错误的版本.

[issue 275]( http://xxx/xxx/issues/275)
pipixia
2019-08-02 17:42:05 +08:00
bug 号
Felldeadbird
2019-08-02 17:42:13 +08:00
任务下达类，有等级的，则以系统的 ID，如：#1024 任务标题

临时性的，则 修复 /新增 /删除 XXX
SingeeKing
2019-08-02 17:44:13 +08:00
https://github.com/angular/angular/blob/master/CONTRIBUTING.md
deepdark
2019-08-02 17:47:57 +08:00
我一般是 [ bug ] fix #100, add xxx to xxx
[ feature ] add xxx views/functions
wunonglin
2019-08-02 17:49:34 +08:00
no message

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

https://tanronggui.xyz/t/588586

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

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

© 2021 V2EX