提交信息规范
使用清晰的提交信息可以让团队协作更顺畅。推荐使用 Conventional Commits 规范:
<type>(<scope>): <subject>
// 类型
feat: 新功能
fix: 修复 bug
docs: 文档更新
style: 代码格式(不影响功能)
refactor: 重构
test: 测试相关
chore: 构建/工具相关
// 示例
feat(auth): add user login feature
fix(api): handle null response in getUser
docs(readme): update installation instructions
分支管理
Git Flow 工作流
main/master- 生产环境分支develop- 开发分支feature/*- 功能分支release/*- 发布分支hotfix/*- 紧急修复分支
简化版工作流
对于小团队,可以使用简化版:
main- 主分支,保持稳定feature/*- 功能分支,从 main 分支创建- 完成后通过 PR 合并到 main
常用命令
日常操作
# 拉取最新代码
git pull --rebase
# 查看状态
git status
# 暂存所有更改
git add .
git add -A
# 提交
git commit -m "feat: add new feature"
# 推送
git push
git push -u origin feature-branch
撤销操作
# 撤销工作区的更改
git restore file.js
git checkout -- file.js # 旧版本
# 撤销暂存的更改
git restore --staged file.js
git reset HEAD file.js # 旧版本
# 撤销最后一次提交(保留更改)
git reset --soft HEAD~1
# 撤销最后一次提交(丢弃更改)
git reset --hard HEAD~1
.gitignore 配置
# 依赖
node_modules/
__pycache__/
# 环境变量
.env
.env.local
# IDE
.idea/
.vscode/
*.swp
# 构建产物
dist/
build/
*.log
# 系统文件
.DS_Store
Thumbs.db
安全最佳实践
- 不要提交敏感信息(密钥、密码等)
- 使用
git-secrets或truffleHog扫描 - 定期审查提交历史
- 使用 signed commits 验证身份
总结
良好的 Git 实践可以提高团队协作效率,减少问题。建议:
- 制定团队的 Git 规范并遵守
- 使用 PR 进行代码审查
- 定期拉取最新代码,减少冲突
- 写清楚提交信息和 PR 描述