Git Commit 提交注释说明
- 1 min 1. 注释说明
- 注释较多内容的时候，建议使用标题加正文的方式，标题与正文以空格分割一下，若注释较少则可只写内容
- 标题尽量简洁，尽量使用祈使语气
- 正文每行的长度不易过长，否则不易阅读
- 正文是解释是什么和为什么，而不是怎么实现的
- 如果可以尽量写英文注释（像我英文这么烂只能写写中文了）
2. 关键字
以下关键字尽量出现在正文开头，表示当前完成的功能
- feat：新功能（feature）
- fix：修补bug
- mod：修改
- del：删除
- docs：文档（documentation）
- style： 格式（不影响代码运行的变动）
- refactor：重构（即不是新增功能，也不是修改bug的代码变动）
- test：增加测试
- chore：构建过程或辅助工具的变动
3. 例子
新增状态码设置，修改账号验证方式，修复邮箱验证已经删除账号注册登录
1.Feat 状态码设置接口，/api/code/get
2.Mod 账号验证方式，不允许出现特殊字符，如…
3.Fix 邮箱验证不通过的问题
4.Del 账号注册登录，改为手机号验证码登录
PS:
由于本人水平有限，文章在表述和代码方面如有不妥之处，欢迎批评指正。