前端学习之路,前端开发人员如何在团队中规范git commit提交记录
摘要
近期在review团队的部分代码,对比个人初期与如今的git提交记录,发现初期的提交记录简直是五花八门,言不由衷,让人一打眼看去就觉得这写的什么东西。一个好的git提交记录既方便个人快速的了解自我的工作进度、快速的回退版本等,又便于团队之间的协同开发。故分享一下当前最为规范、流行的git commit提交规范,希望这次分享可以帮助到你。
Commit Message格式
每次我们的提交代码改动,commit message包括三个部分:Header、Body和Footer。(Header是必须的,Body和Footer可以省略,引用阮大神的文,下面只讲header的规范写法,其余部分可以浏览阮大神文章进行学习)
Header
Header包含三个字段:type、scope和subject(type和subject是必须的)
(1)type
feat:新特性、新增feature fix:修改问题、修复bug refactor:代码重构:没有新增新功能或修复bug docs:文档修改:仅仅是修改了文档,例如README.MD style:代码格式修改,注意不是css修改(仅仅是对格式进行修改,例如逗号、缩进、空格等。不改变代码逻辑) test:测试用例修改:包括单元测试、集成测试 chore:其他修改,比如改变构建流程、或增加删除依赖库、工具等 pref:优化相关:如提升性能、用户体验等 revert:版本回滚 build:构造工具或外部依赖的改动,例如webpack、npm ci:与CI(持续集成服务)有关的改动
(2)scope
scope用于说明commit影响的范围,比如component,route等等,根据项目的情况进行不同的情况改动。
(3)subject
subject是commit目的的简要概述,不超过50字符。
测试
提交改动记录
git commit -m "feat(src/pages/case):添加案例轮播图下一页导航按钮"
提交结果
参考文献
https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html
赞 (0)