Git-SourceTree使用规范

清疚 2022-06-09 05:11 416阅读 0赞

项目使用Git以来，出现了多次因开发提交失误，导致代码冲突，他人代码被覆盖的问题，甚至造成生产问题。下文总结了Git-SourceTree使用的一些规范，从开发提交代码自我审查，到分支管理规范，避免代码冲突。

1.Clone前先创建Fork私有库，命名规范：“系统编码-工号”或 “系统编码-姓名全拼”或 “系统编码-工号-姓名全拼”组成。私有库命名规范避免自己有多个Fork私有库分不清楚，也让其他同事更清楚是谁提交的代码；

2.工具-选项 打开后如下，配置自己的全名和邮箱。设置自己的名字，让其他同事知道是你提交的代码，有问题方便交流，设置自己的邮箱，当提交的代码被合并后，将收到邮件提醒；  
![这里写图片描述][SouthEast]

3.禁止在master上开发代码，Create Branch 创建topic分支。

4.远程分支发生变化时，要及时创建与之对应本地topic分支，比如topic/V1.1的代码提交到release/V1.1，topic/V1.2的代码提交到release/V1.2。禁止使用同一个topic分支对不同的远程分支进行代码提交，否则及容易出现冲突；

5.提交代码前，先更新分支最新代码，有冲突优先解决冲突。提交前一定要先更新代码、提交前一定要先更新代码、提交前一定要先更新代码。。。。。

6.更新代码显示冲突时，先把自己本地的代码暂存->更新代码->应用暂存->解决冲突->最后再按照正常流程提交代码。解决冲突时，一定要看清楚，切记不要把别人的代码覆盖掉，同一个文件中冲突过多的情况下，请使用对比工具，比如 ，避免因为没注意而造成代码覆盖（这个坑我跳过）；

7.提交时要描述清楚，不能只写 修改bug 提交代码 修改配置文件。。。

8.代码merge人员，需检查研发人员提交代码是否合理，重点检查xml文件和配置文件，资源文件。

9.提交代码前，一定要仔细检查改动代码是否合理，本地sourcetree提交检查，远程仓库提交再次检查。如发现提交代码有不是自己改动代码，解决恢复，重新提交。

***10.有时更新代码后，会发现“未暂存文件中”莫名其妙的出现了很多不是自己修改文件，此时最好的解决办法是，放弃当前的本地分支，重新Create Branch 一个全新的topic分支，在新分支上提交自己的修改。如果远程仓库提交检查时，发现提交代码有不是自己改动代码，要马上解决恢复，重新提交。出现这种问题一般是，同一个topic分支对不同的远程分支进行了代码提交，或提交的代码被驳回。***

[SouthEast]: /images/20220609/dd8fafa45fcd49f6a00d41dbbd6b6846.png