GIT_CHECKLIST.md

Git 提交前检查清单

📋 提交前必检项目

✅ 已完成的清理工作

1. 临时文件清理

   • ✅ 删除 test_file.txt (测试文件)
   • ✅ 删除 downloaded_file.txt (下载测试文件)
   • ✅ 删除 websocket_test.html (临时测试页面)
   • ✅ 清空 uploads/ 目录 (用户上传文件)
   • ✅ 清理 build/ 目录 (构建缓存)

2. 敏感信息保护

   • ✅ 创建 application.properties.example 示例配置
   • ✅ 修改 application.properties 使用环境变量
   • ✅ 创建 .env.example 环境变量示例
   • ✅ 更新 .gitignore 忽略敏感文件

3. Git忽略规则完善

   • ✅ Spring Boot 项目标准忽略规则
   • ✅ IDE 文件忽略 (IntelliJ IDEA, VS Code, Eclipse)
   • ✅ 操作系统文件忽略 (.DS_Store, Thumbs.db)
   • ✅ 日志文件和临时文件忽略
   • ✅ 数据库和配置文件敏感信息忽略
   • ✅ 文件上传目录忽略

📁 将被提交的重要文件

核心代码文件

• src/main/java/com/sakura/three_f/ - 所有Java源代码
• src/test/java/com/sakura/three_f/ - 测试代码
• src/main/resources/ - 资源文件

配置文件

• build.gradle - 项目构建配置
• settings.gradle - Gradle设置
• src/main/resources/application.properties - 应用配置(已脱敏)
• src/main/resources/application.properties.example - 配置示例
• src/main/resources/sql/schema.sql - 数据库脚本
• src/main/resources/static/index.html - 静态页面

文档文件

• README.md - 项目说明文档
• SETUP.md - 部署指南
• GIT_CHECKLIST.md - 本检查清单
• .env.example - 环境变量示例

Git配置

• .gitignore - Git忽略规则

Gradle包装器

• gradle/wrapper/ - Gradle包装器文件
• gradlew - Gradle包装器脚本(Unix)
• gradlew.bat - Gradle包装器脚本(Windows)

⚠️ 被忽略的文件/目录

构建和缓存

• build/ - 构建输出目录
• .gradle/ - Gradle缓存
• out/ - IDE输出目录

IDE配置

• .idea/ - IntelliJ IDEA配置
• .vscode/ - VS Code配置
• *.iml - IntelliJ模块文件

敏感信息

• .env - 环境变量文件
• application-*.properties - 环境特定配置
• *.key, *.pem - 密钥文件

运行时文件

• uploads/ - 用户上传文件目录
• logs/ - 日志文件目录
• *.log - 日志文件

临时文件

• *.tmp, *.temp - 临时文件
• test_file.* - 测试文件
• downloaded_file.* - 下载测试文件

🔒 安全检查

1. 数据库配置

   • ✅ 数据库密码使用环境变量 ${DB_PASSWORD:your_password}
   • ✅ 数据库用户名使用环境变量 ${DB_USERNAME:root}

2. JWT配置

   • ✅ JWT密钥使用环境变量 ${JWT_SECRET:your_jwt_secret_key...}
   • ✅ 示例配置中使用占位符

3. Redis配置

   • ✅ Redis密码使用环境变量 ${REDIS_PASSWORD:}

📝 提交建议

初始提交消息示例

feat: 初始化Three F综合性Web应用项目

- 实现用户管理模块(注册、登录、JWT认证)
- 实现文件传输模块(上传、下载、权限控制)
- 配置WebSocket实时聊天基础设施
- 集成Spring Security安全框架
- 配置MySQL数据库和Redis缓存
- 完善项目文档和部署指南

技术栈: Spring Boot 3.5.3 + MySQL + Redis + WebSocket

后续提交规范

• feat: 新功能
• fix: 修复bug
• docs: 文档更新
• style: 代码格式调整
• refactor: 代码重构
• test: 测试相关
• chore: 构建过程或辅助工具的变动

🚀 提交后步骤

1. 验证提交内容

   git status
   git log --oneline -5

2. 检查远程仓库

   • 确认所有重要文件已上传
   • 确认敏感信息未泄露
   • 检查README.md在GitHub上显示正常

3. 设置分支保护

   • 配置main分支保护规则
   • 要求Pull Request审查
   • 启用状态检查

4. 配置CI/CD

   • 设置GitHub Actions工作流
   • 配置自动化测试
   • 设置部署流水线

⚡ 快速命令

# 检查当前状态
git status

# 添加所有文件
git add .

# 提交
git commit -m "feat: 初始化Three F综合性Web应用项目"

# 推送到远程仓库
git push origin main