Git版本控制工具使用说明和规范

it的使用尤其是多人合作，注意以下几点：

1、推送服务器前先同步;

2、两个分支版本有冲突，先rebase解决，不熟练的情况下暂时不要使用merge;

3、版本节点不能使用中文，修改描述可以，关于修改描述的规范见下一章;

4、编译自动生成的临时文件不要提交，可以使用TortoiseGit–>Delete and add in ignore list，可过滤指定的文件，即使有改动也不提交;

5、Git自带的比较工具比较差，可以配置使用外部比较工具。

一共三处，将Diff viewer和Merge Tool改为HA-BCompare。1.1 用户名

为保证问题跟踪方便，历史修改记录溯源，首次提交前必须设置用户名和邮箱，尤其是用户名，必须使用自己名字的小写全拼，不得使用简称或者特殊代号。

1.2 分支名

功能接近的项目，尽量使用功能宏或者项目宏，从软件源码上减少分支;

分支名称使用大写字母和下划线，不能包含空格或中文;

临时测试或验证某个功能的分支，必须以TEST_开头，验证无误，且应用到正式项目后，最好删除远程分支;

某个版本基础上小改动，为解决生产或者客户问题的版本，必须以PATCH_开头，表示当前分支只是特殊情况下使用，后续正式版本不再继续维护升级;

因为需求变更，原XXX项目不得不分成2个分支，分支命名为XXX_AA和XXX_BB，其中AA和BB是两个分支的主要区别关键字，前面一样，表示两分支原属于同一个分支节点;若后续XXX_BB继续拆分，则新分支为XXX_BB_CC和XXX_BB_DD，依次类推;

禁止使用XXX1 XXX2 XXX3 这种分支名，禁止设分支名为master。

个人测试或者reabse前的远程分支，原作者确认已经不再需要的，必须删除远程分支，简化版本分支树形结构。

1.3 注释

修改记录规范化是本文的重点，注释按如下格式编写：

reate 初次创建新项目时使用

remove 删减代码时使用

patch 集成合并SDK补丁

message 用于指定提交的描述文字，需要注意几个事项。

1、使用中文表述，描述简洁，抓住重点，尤其对修复的问题点

2、尽量以动词开头，如：更新，增加，修复等

3、特别复杂的功能或流程，可描述参考某文档，并更新上传说明文档，

正确的示例：

[release] 发布V1.0.0_2021

[fix] 修复登录框显示阴影的问题

[update] 优化RFID卡信息读取的驱动

[test] 添加解码GNSS测试功能

[remove] 删除多余的提示框界面相关代码

错误的示例：

[fix] 修复一个大 BUG //具体是什么问题?

添加联网模块 //没有 type [add]

[add] 更新 API 文档接口说明 // type错误，应该是[doc

（编辑：东莞站长网）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!