Git 最佳实践原则 | 青训营

64 阅读2分钟

已经有大量的朋友们总结的Git的安装、相关使用介绍了。这篇文章将分享一下git的实践规范,使用统一的git规范,可以帮助我们团队之间的合作更加便捷快速。

1. 多使用命令行

使用git,优先推荐使用命令行操作,对于git 的操作自行百度,git 常用的命令大家在常用的基础上是很容易记住的,如果忘了,也可以通过快速 google/baidu 查到。IDE或者其他客户端的图形化界面也非常好用,但是不推荐,因为如果我们在服务器上写代码,没有这些工具,我们还是需要使用命令行进行操作,所以熟记常用git 命令是必备的技能。

2. 写好commit message

我们通过commit 的message 可以快速的了解我们这次的改动是什么,但是如果commit message随便写的话,我们无法知道我们的每次提交是做了何种改动,对于其他人阅读代码,或者进行code review会造成很大的困恼。保持可读的 commit 信息有助于在查看 git log 的时候清楚的追溯哪些 commit 提交了哪些信息。

例如git项目中所提到的规范。

  1. 区别标题(subject) 和内容(body)(可选),用空行隔开
  2. subject 一般不超过50个字符, 主要展示开发了什么功能(如果太多功能应该多次commit)
  3. subject 首字母大写
  4. subject 结尾不需要句号结尾
  5. body 每一行控制在72个字符
  6. body 是用来详细解释commit 做了什么

3. 不要忽略.gitignore

对于代码仓库,往往我们只需要存放代码,有一些像是代码的中间产物,例如cache, 或者 IDE 的代码产物如.idea/,或者 Mac 的各种冗余文件,如DS_Store 等,我们都不希望push 到远程代码仓库。我们可以在文件目录下,创建 .gitignore 文件。这样子可以避免在使用 git add . 的时候,添加了不必要的文件。对于常见的各种语言的 gitignore 文件可以参考代码仓库gitignore, 大家直接复制粘贴就行。

假设文件已经被使用 git add 添加了,这时候使用 gitignore 是没有用的,该文件并不会被删除,我们这时候可以命令

  • 当远程仓库不需要该文件,且本地也不需要,可以使用
    git rm -f 要删除的文件
  • 当远程仓库不需要该文件,但本地需要,可以使用
    git rm -f --cache 要删除的文件