Git建议-代码库里放什么

2024/05/20 | 字数710 | 阅读2分钟


我们在做项目的时候,会遇到各种各样的文件,除了代码之外,还有其它,比如:三方库、图片、视频、编译脚本、部署脚本等等。这么多文件都放到git里吗?下面是可能遇到的文件类型以及处理方式的建议,请参考:

  1. 功能代码 - git管理;
  2. 三方库 - 如果不需要修改,则存储二进制库到git LFS中管理,如果需要修改,则以源码的方式放到git库中,如果三方库是从源码编译生成,则最好写好一个编译脚本(包含编译命令,参数)放到git中统一维护;
  3. 编译脚本 - git管理;
  4. 部署脚本 - git管理;
  5. 图片&视频 - 这类文件一般是作为App或者Web页面的资源使用,建议放到使用git LFS来管理,保持代码库轻量化;
  6. 编译环境 - 编译环境搭建脚本放到git中维护,包括操作系统版本,编译器版本,依赖库的版本等;
  7. 运行环境 - 运行环境搭建脚本放到git中维护,包括操作系统版本,依赖库等;
  8. 测试代码 - git管理;
  9. lint以及style检查脚本 - git管理;
  10. 软件发布包 - 单独的归档服务器维护,不适合放到git中;
  11. 编辑器配置 - git管理(可选),例如.vimrc, .editorconfig, vscode.json等;
  12. 文档 - git管理,可以采用markdown格式,文本格式,支持编辑、查看以及导出pdf等功能;

一个简单的原则就是:


总的来说,和项目有关的所有内容,全部纳入配置管理系统中,从环境搭建、软件开发、系统集成、软件测试、部署运行、文档编写等,全流程跟踪,让所有成员都有一个统一的开发运行环境。关于环境的搭建,如果可以的话,采用docker的方式(编译环境和运行环境)可能是一个比较理想的选择。

上一篇:Git使用-commit信息怎么写 下一篇:Git使用-系统差异

【文章不错,鼓励一下】