GIT_必须文件清单.md 4.4 KB

Android项目Git必须文件清单

📋 核心配置文件(必须)

1. 项目根目录

  • build.gradle - 项目级构建配置
  • settings.gradle - 模块配置
  • gradle.properties - Gradle属性配置
  • .gitignore - Git忽略规则(已存在)
  • gradlew - Gradle Wrapper脚本(Unix/Mac)
  • gradlew.bat - Gradle Wrapper脚本(Windows)
  • gradle/wrapper/gradle-wrapper.jar - Gradle Wrapper JAR
  • gradle/wrapper/gradle-wrapper.properties - Gradle Wrapper配置

2. 应用模块 (app/)

  • app/build.gradle - 应用构建配置
  • app/proguard-rules.pro - ProGuard混淆规则
  • app/src/main/AndroidManifest.xml - 应用清单文件
  • app/src/main/java/**/*.java - Java源代码
  • app/src/main/res/** - 资源文件(drawable, layout, values等)
  • app/src/main/assets/** - Assets资源文件
  • ⚠️ app/libs/**/*.aar - 第三方AAR库(如果项目依赖)
  • ⚠️ app/heartRateBand.jks - 签名密钥文件(建议不要提交,使用环境变量或单独管理

3. 其他模块

每个模块都需要以下文件:

  • 模块名/build.gradle - 模块构建配置
  • 模块名/proguard-rules.pro - ProGuard规则(如果有)
  • 模块名/src/main/AndroidManifest.xml - 模块清单文件
  • 模块名/src/main/java/**/*.java - Java源代码
  • 模块名/src/main/res/** - 资源文件
  • 模块名/src/main/assets/** - Assets资源(如果有)
  • 模块名/src/main/jniLibs/** - 原生库(.so文件,如果有)
  • 模块名/libs/** - 模块依赖的库文件(如果有)

具体模块:

  • core/ - 核心模块
  • ICDeviceManager/ - IC设备管理模块
  • uniplugin_module/ - UniApp插件模块
  • myLockView/ - 锁屏视图模块
  • myWIFIView/ - WiFi视图模块
  • UpdateHelper/ - 更新助手模块

4. 文档文件(可选但建议)

  • README.md - 项目说明(如果有)
  • *.md - 其他文档文件(如:快速开始.mdKIOSK_SETUP_GUIDE.md等)

5. 脚本文件(可选)

  • *.bat - Windows批处理脚本(如果有用)

❌ 不应该提交的文件

构建产物(已在.gitignore中)

  • build/ - 所有构建输出目录
  • app/build/ - 应用构建输出
  • *.iml - IntelliJ IDEA模块文件
  • .gradle/ - Gradle缓存
  • local.properties - 本地配置(包含SDK路径等)

IDE文件

  • .idea/ - IntelliJ IDEA配置(部分)
  • .DS_Store - macOS系统文件

敏感文件

  • ⚠️ *.jks - 签名密钥文件(强烈建议不要提交
  • ⚠️ local.properties - 包含本地路径配置

🔒 安全建议

签名密钥文件处理

不要提交以下文件到Git:

  • app/heartRateBand.jks
  • UpdateHelper/UpdateHelper.jks

建议做法:

  1. 将这些文件添加到 .gitignore
  2. 使用环境变量或CI/CD系统管理密钥
  3. 在团队中通过安全渠道共享密钥

更新.gitignore

建议在 .gitignore 中添加:

# 签名密钥文件
*.jks
*.keystore

📝 快速检查清单

在提交到Git之前,确认:

  • 所有源代码文件(.java, .kt)
  • 所有资源文件(res/, assets/)
  • 所有构建配置文件(build.gradle, settings.gradle)
  • Gradle Wrapper文件(gradlew, gradlew.bat, gradle/wrapper/)
  • AndroidManifest.xml文件
  • ProGuard规则文件
  • 第三方库文件(libs/中的.aar, .jar)
  • 原生库文件(jniLibs/中的.so)
  • 文档文件(README.md等)
  • .gitignore文件已正确配置
  • 签名密钥文件(.jks)已排除
  • local.properties已排除
  • build/目录已排除

🚀 Git初始化命令

cd E:\TPlat\HeartRateProject\bBeng-HeartRate-4.66-pad

# 初始化Git仓库
git init

# 添加所有文件(.gitignore会自动排除不需要的文件)
git add .

# 提交
git commit -m "Initial commit: Android HeartRate project"

📌 注意事项

  1. 首次提交前检查:运行 git status 查看将要提交的文件,确保没有敏感信息
  2. 大文件处理:如果assets/或libs/中有大文件,考虑使用Git LFS
  3. 分支策略:建议使用main/master分支,并考虑创建develop分支用于开发
  4. 提交信息:使用清晰的提交信息,遵循约定式提交规范