← 返回目录

8. 存档说明怎么写?(带个小评委)

commit 说明怎么写?一个好的 commit message 让你三个月后还记得改了啥。

核心格式:
type: 简短描述——如 "feat: 加了登录功能"
type 类型——feat 新功能 / fix 修 bug / docs 文档 / style 格式
描述要具体——别写"改了点东西"

坑:别写"update""修改"这种废话、多人协作时说明要规范、看完别人 commit 能知道改了啥

8.1 互动演示:存档说明小评委

先写一句话,点「让评委看看」,这里会显示你敲的 commit 命令。

8.2 规范写法:类型(范围): 干啥了

# 格式就一句话:
类型(范围): 这次干了啥

# 例:
feat(login): 加了短信验证码登录
fix(cart): 修了购物车数量是0时删不掉的毛病
docs(说明): 更新了安装步骤
类型这个词啥意思什么时候用
feat加新功能做了个之前没有的新玩意儿
fix修毛病修了个 bug
docs改文档只改了 README、注释
style改排版只调了空格、缩进,逻辑没变
refactor整理代码没加功能也没修 bug,只是把代码理顺
perf提速让代码跑更快
test加测试写/改测试代码
chore杂事改配置、装依赖这种杂活

反面 vs 正面,一眼看出差别

反面(废便签)正面(看得懂的便签)
修改一下feat(login): 加了短信验证码登录
改bugfix(cart): 修了数量是0时删不掉
update / save / testdocs(readme): 更新安装说明
完成了 / 差不多了style(header): 统一导航栏字号

如果你一直写"修改一下",会怎样?因为三个月后你想找"购物车那次改动",只能去翻记录,结果满屏都是"修改一下",根本搜不出来。写规范点,一搜"cart"全出来了。

实战:用在哪 / 常见坑 / 怎么解决

① 在哪用:每一次点"提交"前,都在输入框写一句规范说明。

② 常见坑:随手写"修改一下""改bug",三个月后翻 git log 全是看不懂的废纸。

③ 怎么解决:照 类型(范围): 描述 写,提交前先用本页小评委过一遍。

一句话记住:类型(范围): 干啥了;feat 加功能、fix 修毛病、docs 改文档、style 改排版、refactor 整理

本页命令速查

命令作用常用参数说明代码示例
git commit -m "类型(范围):描述"存档说明feat/fix/docs…规范写法如 feat(login): 加了验证码登录git commit -m "feat(login): 加了验证码"