← 返回目录

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

每次存档都要写一句"说明",这句话就是代码的"便签纸"。你要是写"改了一下",三个月后翻记录,自己都不知道当时改了啥。业界有个通用写法:类型(范围): 干啥了。下面这个小评委,你随便写一句,它立刻帮你打分。

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

试试输入:"修改一下" 或 "feat(login): 加了验证码登录"。

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 整理