为什么我选择使用约定式提交规范: feat, doc, chore, fix

2024-03-13 10:12:59 +08:00
 usboy

使用约定式提交规范可以让代码的提交信息更明确,方便团队成员之间的沟通。

比如:

我个人认为,使用约定式提交规范可以提高代码的可读性和维护性,你们常用的提交规范有哪些?

4979 次点击
所在节点    git
43 条回复
Harold2Finch
2024-03-13 10:16:56 +08:00
我用 idea 里面的一个插件 Git Commit Template 。除了你列的这几个还有很多别的
NessajCN
2024-03-13 10:21:37 +08:00
因为用 close/fix/resolve 可以在相关 issue 里直接显示
rossroma
2024-03-13 10:21:41 +08:00
merge:这个不用解释了吧;
refactor: 代码重构,未改变逻辑,只做代码优化;
style: 只修改了样式,这个前端会用到;
fzls
2024-03-13 10:24:40 +08:00
我也喜欢用这个,有时候还附带个括号表明修改范围
bojackhorseman
2024-03-13 10:26:22 +08:00
usboy
2024-03-13 10:26:57 +08:00
@NessajCN 也可以通过 Github Actions 生成友好的 Changelog
usboy
2024-03-13 10:30:54 +08:00
@bojackhorseman

“Code changes that do not impact the functionality (e.g., formatting, white-space, etc)”
-- 摘自这份约定式提交备忘单: https://cheatsheets.zip/conventional-commits
rossroma
2024-03-13 10:35:18 +08:00
@bojackhorseman 你说的对,代码格式化可以使用 style ,css 的修改一般是有语义的,使用 style 可能不太合适。
0o0O0o0O0o
2024-03-13 11:01:50 +08:00
虽然用,但是不够理解,有时候还是会犹豫到底用哪个 type ,要是有人可以做个类似 https://distrochooser.de/zh-hans 的工具就好了
wolfie
2024-03-13 11:02:28 +08:00
这不是很常见的规范之一吗。
BeiChuanAlex
2024-03-13 11:26:20 +08:00
这不是在企业里面必须遵守的规定吗?而且也不止这几个啊。
wenwei1202k
2024-03-13 11:27:59 +08:00
这个不是可以安装下插件,git cz 直接选相关的提交类型就可以了,还会让你写简略和详细说明,是否有 breaking change , 然后配合相关的版本和 change-log 的工具,发布版本时候自动更新 changelog ,这套流程已经算很成熟了
Martens
2024-03-13 11:31:33 +08:00
jb 系列的 ide 里有什么推荐的插件吗
civetcat
2024-03-13 11:38:19 +08:00
搜了下 jetbrains 里面好多类似的插件,有哪款比较好用的吗
alleluya
2024-03-13 11:47:35 +08:00
@0o0O0o0O0o 前端的话 建议用这个 https://github.com/legend80s/git-commit-msg-linter 省的自己配 husky 了 用的是 ng 的那套约定 我觉得足够一般开发了
agagega
2024-03-13 11:53:34 +08:00
用 Emoji 好了
body007
2024-03-13 11:54:55 +08:00
idea 的 Git Commit Message Helper 插件也可以看看。
otakustay
2024-03-13 12:27:53 +08:00
@alleluya 比较流行的是 commitlint 吧,这个才 300 多 star 有点小众了
ZedRover
2024-03-13 13:29:00 +08:00
npx czg ai 命令行里面可以使用 gpt
sjhhjx0122
2024-03-13 13:37:36 +08:00
npm 装个全局 git-cz 就能摆脱编辑器,直接命令行写了

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

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

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

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

© 2021 V2EX