Git使用经验分享

Git是非常流行的代码管理工具，除了掌握Git的命令外，这里总结了一些使用经验，供大家参考。

1、提交频繁,每个提交保持较小的改动范围

例如,你完成了登录功能的开发,可以先提交一次。然后又完成了登录失败的错误处理,可以再提交一次。这样每个提交的改动都较小且独立,如果后面发现登录失败处理有问题,可以方便地回滚到上一个提交。

2、提交信息要写的清晰明了

好的提交信息例子: "增加用户登录功能", "修复登录失败时的空指针异常,关闭issue #123"。
不好的例子: "修改代码", "各种bugfix"。
清晰的提交信息让人一眼就能看出这次提交的目的,方便团队沟通和后期维护。

3、新功能开发或bug修复最好在单独的分支上进行

例如,你要开发一个用户注册功能,可以从主分支(如master)创建一个新的分支"feature/user-registration",在这个分支上进行开发。开发完成并测试通过后,再合并回主分支。这样可以避免在开发过程中影响主分支的稳定性。

4、使用有意义的分支名称

好的分支名称例子: "feature/user-login", "bugfix/issue-123", "refactor/optimize-performance"。
不好的例子: "dev", "fix", "temp"。
有意义的分支名称可以让团队成员快速了解分支的用途。

5、定期从远程仓库拉取更新

例如,你每天开始工作前,先执行一次git pull,拉取远程仓库的最新更改。这样可以尽早发现并解决潜在的代码冲突。

6、在push到远程仓库之前,先在本地测试运行

例如,你完成了一个新功能的开发,在git push之前,先在本地运行单元测试,确保所有测试用例都通过。这样可以避免将有问题的代码推送到远程仓库,影响其他人。

7、善用.gitignore文件

例如,在.gitignore文件中添加以下内容:

*.class
*.log
target/
.idea/

这样可以避免将编译产生的.class文件、日志文件、构建目录以及IDE特定的配置文件提交到Git仓库中。

8、进行code review

例如,你完成了一个新功能的开发,可以创建一个Pull Request(PR),请求团队成员review你的代码。通过code review,可以发现潜在的问题,提高代码质量,并促进知识共享。

9、使用Git钩子脚本(hooks)自动化一些流程

例如,你可以在pre-commit钩子中添加代码格式化和lint检查的脚本,确保提交的代码符合团队的编码规范。在pre-push钩子中添加单元测试的脚本,确保所有测试用例都通过后才能推送到远程仓库。

10、定期清理已经合并的分支

例如,你完成了用户注册功能的开发,并将"feature/user-registration"分支合并到了主分支。这时候可以删除这个已经合并的分支,以保持分支列表的整洁。可以使用命令git branch -d feature/user-registration来删除本地分支,使用git push origin --delete feature/user-registration来删除远程分支。

11、发布版本时打上版本号标签

例如,当你发布了1.0.0版本时,可以在对应的提交上打一个标签:

git tag -a v1.0.0 -m "发布1.0.0版本"
git push origin v1.0.0

这样可以方便地标识和回溯每个版本。

12、考虑使用Git工作流

例如,GitFlow工作流定义了一套规范的分支使用方式:

• master分支存储正式发布的版本
• develop分支作为开发的主分支
• feature分支从develop分支创建,用于开发新功能
• release分支从develop分支创建,用于准备新的发布
• hotfix分支从master分支创建,用于修复线上问题
  团队可以根据自己的情况选择或调整合适的工作流。

13、对于大的二进制文件,考虑使用Git LFS

例如,你的项目中有一些大的图片或视频文件,可以使用Git LFS来管理它们。安装Git LFS后,可以使用以下命令来追踪这些文件:

git lfs track "*.psd"
git add .gitattributes

然后像平常一样add、commit和push这些文件,Git LFS会将它们存储在单独的服务器上,而不是直接存在Git仓库中,避免仓库过大。

14、灾难恢复,定期备份仓库

例如,你可以定期将Git仓库备份到另一个位置(如另一台服务器或云存储)。可以使用命令git clone --mirror来创建一个包含所有分支和标签的镜像备份。

git clone --mirror git@example.com:myproject.git myproject-backup.git

然后可以将myproject-backup.git上传到备份位置。如果主仓库出现问题,可以从备份恢复。

以上就是对这些Git使用过程中的一些实践经验。希望这些例子能帮助你更好地理解和应用这些实践。记住,这些实践是指导性的,具体如何应用还需要根据你的团队和项目情况来调整。一人经验有限，各位大佬们如果有更多的经验也可以给我留言，我将整理更新到本博文当中，谢谢大家。