使用约定式提交规范可以让代码的提交信息更明确,方便团队成员之间的沟通。
比如:
我个人认为,使用约定式提交规范可以提高代码的可读性和维护性,你们常用的提交规范有哪些?
补充Markdown格式的备忘单链接:https://cheatsheets.zip/conventional-commits
1
Harold2Finch 256 天前
我用 idea 里面的一个插件 Git Commit Template 。除了你列的这几个还有很多别的
|
2
NessajCN 256 天前
因为用 close/fix/resolve 可以在相关 issue 里直接显示
|
3
rossroma 256 天前
merge:这个不用解释了吧;
refactor: 代码重构,未改变逻辑,只做代码优化; style: 只修改了样式,这个前端会用到; |
4
fzls 256 天前 1
我也喜欢用这个,有时候还附带个括号表明修改范围
|
5
bojackhorseman 256 天前
|
7
usboy OP @bojackhorseman
“Code changes that do not impact the functionality (e.g., formatting, white-space, etc)” -- 摘自这份约定式提交备忘单: https://cheatsheets.zip/conventional-commits |
8
rossroma 256 天前
@bojackhorseman 你说的对,代码格式化可以使用 style ,css 的修改一般是有语义的,使用 style 可能不太合适。
|
9
0o0O0o0O0o 256 天前 via iPhone
虽然用,但是不够理解,有时候还是会犹豫到底用哪个 type ,要是有人可以做个类似 https://distrochooser.de/zh-hans 的工具就好了
|
10
wolfie 256 天前
这不是很常见的规范之一吗。
|
11
BeiChuanAlex 256 天前
这不是在企业里面必须遵守的规定吗?而且也不止这几个啊。
|
12
wenwei1202k 256 天前
这个不是可以安装下插件,git cz 直接选相关的提交类型就可以了,还会让你写简略和详细说明,是否有 breaking change , 然后配合相关的版本和 change-log 的工具,发布版本时候自动更新 changelog ,这套流程已经算很成熟了
|
13
Martens 256 天前
jb 系列的 ide 里有什么推荐的插件吗
|
14
civetcat 256 天前
|
15
alleluya 256 天前 1
@0o0O0o0O0o 前端的话 建议用这个 https://github.com/legend80s/git-commit-msg-linter 省的自己配 husky 了 用的是 ng 的那套约定 我觉得足够一般开发了
|
16
agagega 256 天前 via iPhone 1
用 Emoji 好了
|
17
body007 256 天前
idea 的 Git Commit Message Helper 插件也可以看看。
|
19
ZedRover 256 天前
npx czg ai 命令行里面可以使用 gpt
|
20
sjhhjx0122 256 天前
npm 装个全局 git-cz 就能摆脱编辑器,直接命令行写了
|
21
usboy OP git-cz 和 czg ai 可以的
|
22
qinfengge 256 天前
|
23
icyalala 256 天前
commit logs 有意义即可
要说方便沟通我更喜欢这种: https://github.com/ahmadawais/Emoji-Log |
24
chawuchiren 256 天前
有一个小疑问,根据 commit msg 生成 changelog 的话,如果中间提交 要怎么写,比如一个新功能 feat: xxx ,但是我写了 bug ,然后修复,这个时候是 feat: xxx 还是用 fix: xxx?
|
25
Cabana 256 天前
|
26
drymonfidelia 256 天前
|
27
drymonfidelia 256 天前
@drymonfidelia 公司的主要项目之一,最高的时候月流水一千万
|
28
nqlair 256 天前
|
29
zgw0 256 天前
我感觉 chore 的意义很模糊,所有的改动都可以说是 feat 或 fix 什么样的改动算是 chore 呢
|
30
yangzzz 256 天前
相同的提交规范,只不过我会在后面加点干了些啥活
|
31
alleluya 256 天前
@otakustay 足够用了 而且你看 readme 就是平替 commitlint 的 起码你的工程里不需要 commitlint+husky 只要这一个就够了 对我来说比配置 commitlint 来的简单 install 之后基本就可以用了
|
32
dyc12389 256 天前
@drymonfidelia #26 这可能才是大多数项目
|
34
palxie 256 天前
我们的格式是 [jira 号] chore/feature/fix: commit message.
在 Gitlab 上 jira 号可以配置成 link. 方便到对应的 jira 上. |
35
usboy OP @drymonfidelia 逗笑我了
|
36
echo0x000001 256 天前
@drymonfidelia 搞复杂了,我就一个字母 ’m‘ ,表示 modify
|
38
SeaRecluse 256 天前
我们是 A(add)/M(modify)/B(bug)/O(optimization)
|
39
chawuchiren 256 天前
@drymonfidelia 现实执行过程中,很常见,就是有些人习惯性的在 commit debug ,所以根本无法描述当前提交的内容,只能 update
|
42
yaocy 256 天前 via iPhone
我也很疑惑,有时候写了一些代码,但是又不足以称得上是一个完整的功能,feat 不合适,又不知道该标记什么
|