引言
好的提交规范,有助于作业者回顾前面工作内容,方便自己和他人查阅代码记录,也是个人职业形象的延伸。
- 提交代码时,说明文字应包括三个部分:header,body 和 footer。
<type>(<scope>): <subject>
//记得空1行
<body>
//记得空1行
<footer>
- 其中type和subject为必须,body和footer可以省略。
feat或add:新功能
update: 更新
fix:修复的缺陷
docs:文档
style: UI样式
refactor:代码重构
test:增加测试
chore:构建过程或辅助工具的变动
如果type为feat和fix,则给提交将出现在 Change log 之中。其他情况将默认不进入 Change log,可自行调整。
- scope用于说明影响的范围,如:
update(xxxController):完善了xxxController的xx细节。
- 如果提交内容影响了多个scope,则可以使用星号*代替,如:
update(*):完善了xx、yy等多处。
每天进步一点点,成就更好的你。