Git使用建议及规范

基于日常使用git比较频繁,整理了以下git使用和管理建议

commit规范

  • 尽量做到每一次commit都带上有意义的、方便搜索的提交消息;
  • 尽量将不同操作目的的commit分开进行commit,方便后续开发时能直接看到指定代码修改的目的,以及进行其他操作
  • 第一行因为有长度限制,一般以以下字段作为前缀,后可以使用冒号加空格隔开再添加概述
    • fix -- 修复bug
    • perf -- 优化
    • feat -- 新增特性
    • docs -- 修改文档
    • style -- 修改了代码格式,不改变代码逻辑
    • refactor -- 代码重构,没有新增新功能或者修复bug
    • test -- 测试用例
    • revert -- 回滚某一次提交或者版本
    • chore -- 改变构建流程,或者增加依赖库、工具等
  • 详细内容可在概述后空一行开始填写,每一条描述使用单独一行说明。

branch规范

  • 按分支的开发目的进行划分,一般以以下字段作为前缀
    • fix -- 修复bug
    • perf -- 优化性能、体验
    • feature -- 新增特性
    • hotfix(临时用) -- 对线上的版本作紧急修复
  • 重要分支要设置分支保护
  • 并入(merge)保护分支前,创建merge request分支(部分git平台浏览器有自带功能)

merge规范

  • merge前,先pull拉取别人对该分支的修改,解决完冲突后再push,避免需要用到--force/-f
  • merge时发生冲突的时候,处理完冲突,暂存完后。再检查一遍这次的变动,最好能直接编译一次,再去commit
posted @ 2020-09-19 22:45  albertPaul  阅读(233)  评论(0编辑  收藏  举报