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

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

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

提交类型:bug 修复

修改内容:修复 XXXXXX 的 bug

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

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

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

5341 次点击
所在节点    问与答
50 条回复
Baymaxbowen
2019-08-02 17:56:26 +08:00
使用 commit 模版,就是网上推荐的那个
HuasLeung
2019-08-02 17:59:10 +08:00
no message
zqx
2019-08-02 17:59:19 +08:00
只有 pull request 才需要写清楚改动和技术方案的细节。commit 只是用于检索每条提交记录的不同,而且 PR 之前也应该合并子分支历史 commit 为一条 commit。
dttzmm
2019-08-02 19:44:11 +08:00
提 bug 或需求都是要有编号的,便于追溯,所以 comment 消息一般规范为单号+空格+故障简述
Rocka
2019-08-02 19:56:09 +08:00
Conventional Commits
https://www.conventionalcommits.org
还可以根据 commit msg 生成 changelog
mcfog
2019-08-02 20:09:53 +08:00
拉分支提交一排 wip,pr 前 squash 成一个按规范写

不过楼主你的这个 commit message 问题不是太长了,而是在没有 issue tracker。应该是 fix #1234 然后自动解析到 issue tracker 里对应内容的 ticket
zhw2590582
2019-08-02 20:12:46 +08:00
Bugfix,反正只有我一个人看
zachlhb
2019-08-02 20:14:45 +08:00
如果是新功能增加,就写增加了什么,如果修复 bug,就写项目管理平台里的 bug id
weakish
2019-08-02 20:17:35 +08:00
管理员要求的修改结果则单独开一个 issue,写在 issue 里。

剩下的提交类型和修改内容可以并成一行,类型用 angular 风格的前缀或者 gitmoji,

然后空一行写 close #123 ( 123 为 issue 编号)

偶尔有额外事项需要说明的,可以在 close 前面写一段简短的说明。
Trim21
2019-08-02 20:21:10 +08:00
add new bug (
avenger
2019-08-02 20:22:28 +08:00
wip 😂
noqwerty
2019-08-02 20:28:51 +08:00
commitizen,大大减少了我敲 commit 的时间
Pythondr
2019-08-02 22:30:32 +08:00
sepdy
2019-08-02 22:39:38 +08:00
gitmoji 挺好玩的
zyzhang
2019-08-02 22:43:31 +08:00
wbing
2019-08-02 22:44:01 +08:00
看到好多人直接 update
txx
2019-08-02 23:00:23 +08:00
commitizen +1
level7in
2019-08-02 23:03:30 +08:00
add:xxx
fix:xxx
WIP:xxx
怒发一版!!!
vibbow
2019-08-02 23:04:37 +08:00
up
minglanyu
2019-08-02 23:05:20 +08:00
gcmsg

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

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

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

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

© 2021 V2EX