提交规范
为什么要制定提交规范?
便于对提交历史进行追溯,以及快速定位
代码改动的历史更加清晰
格式化的 Commit Message 才可以用于自动化输出 Change log
如何制定提交规范?
业界通用的Git提交规范:
<type>(<scope>):<subject>
先来说type:用于说明 Git Commit 的类别,只允许使用下面的标识:
sync:同步主线或分支的bug。
merge:代码合并。
revert:回滚到上一个版本。
chore:构建过程或辅助工具的变动。
test:增加测试。
perf:优化相关,比如提升性能、体验。
refactor:重构(既不是新增功能,也不是修改bug的代码变动)。
style:格式(不影响代码运行的变动)。
docs:文档(documentation)。
fix / to:修复bug,可以是QA(Quality Assurance)发现的bug,也可以是研发自己发现的bug。
feat:新功能(feature)
接下来是scope,顾名思义,就是影响范围,是数据层,控制层,还是视图层?
在JAVA,可以是Controller,Service,Dao等。
在Angular,可以是location,browser,compile,compile,rootScope, ngHref,ngClick,ngView等。
如果你的修改影响了不止一个scope,你可以使用*代替。
最后,subject ,就是描述啦~~这个就不说啦
举例:本次代码修改是优化了xxx
git commit -m "feat(Controller):本次新增加了功能用来xxx"
提交要求
一次提交(commit)只能是一个变更或功能,不允许一次提交多个变更和功能,便于版本回溯及检查
代码提交之前和提交之后必须做如下检查
1.提交修改之前必须验证是否可编译通过、是否已完全解决此问题、是否会导致其他问题
2.对于重要任务,提交后必须重新克隆一份代码验证此次提交是否可编译通过不会导致其他问题。
来说一下常用命令吧~~
git个人信息设置
用户名设置:git config --global user.name
用户邮箱设置:git config --global user.email
示例:
git config --global user.name xiaojin
git config --global user.email xiaojin@lovecode.com
最最最常用的几个命令
显示状态信息
git status
添加提交任务
git add .
获取远程更新并合并到本地仓库
git pull
将暂存区任务提交到本地仓库并添加说明
git commit -m "perf(View): 优化了xxx视图"
将当前提交推送到远程仓库
git push
查看配置信息
git config --list
git config user.name
添加远程仓库
git remote add <shortname> <url>
查看远程仓库
运行git remote命令。它会列出指定的每一个远程服务器的简写。如果已经克隆了远程仓库,那么应该至少能看到origin,这是git克隆的仓库服务器的默认名字
欢迎大家指出文章需要改正之处~
学无止境,合作共赢