Git 使用规范指南

Learn Git Branching

1Git 基础使用流程

1.1初始化与克隆

复制代码
# 初始化本地仓库
git init

# 克隆远程仓库
git clone <repo_url>

一般拉取代码,直接在文件夹界面打开bash,git clone就行了

1.2日常开发流程

1拉取最新代码

复制代码
git pull origin <branch_name>

分支名,拉取远程某个分支代码

2创建/切换分支

复制代码
git checkout -b <branch_name>

创建一个新的分支同时切换到新创建的分支

3添加修改文件

复制代码
git add <file_name>  # 添加单个文件
git add .            # 添加所有改动

4提交代码

复制代码
git commit -m "符合规范的提交信息"

5推送代码

复制代码
git push origin <branch_name>

2.代码提交规范

2.1提交前检查

●通过 git diff 确认改动内容

●确保通过代码检查工具(如 ESLint)

●避免提交调试日志、临时文件(如 .idea/)

2.2提交粒度

●原子性提交:每个提交应仅包含一个功能/修复的完整改动

●避免巨型提交:单次提交建议不超过 300 行代码

2.3merge request(合并请求)

保护分支(如:master),禁止直接push。开发同学提交代码至自己分支之后,创建mr由对应仓库管理员进行review后再合入。

3分支命名规范

3.1分支类型前缀

|--------|----------|----------------------|
| 类型 | 前缀 | 示例 |
| 功能开发 | feature/ | feature/user-login |
| Bug 修复 | bugfix/ | bugfix/login-error |
| 发布分支 | release/ | release/v1.2.0 |
| 热修复 | hotfix/ | hotfix/db-connection |
| 文档 | docs/ | docs/api-update |

3.2命名规则

●全小写,单词用连字符分隔

●包含关联的 Issue ID(可选):feature/123-add-search

4Commit Message 规范

4.1格式要求

复制代码
<type>[optional scope]: <description>

[optional body]

[optional footer]

4.2提交类型

|----------|---------------|
| 类型 | 说明 |
| feat | 新功能 |
| fix | Bug 修复 |
| docs | 文档更新 |
| style | 代码格式调整(不影响逻辑) |
| refactor | 代码重构 |
| test | 测试相关 |
| chore | 构建/依赖更新 |

4.3示例

复制代码
git commit -m "feat(auth): implement OAuth2 login

- Add Google OAuth integration
- Update user schema with social IDs

Closes #123"

5最佳实践与工具

5.1推荐实践

●主分支(main)保护:禁止直接 push,必须通过 PR

●使用 rebase 替代 merge 保持提交历史整洁

●定期执行 git gc 清理仓库

5.2辅助工具

●Commitizen: 交互式提交引导工具

●commitlint: Commit Message 校验

●Husky: Git 钩子管理

●Git Flow: 分支管理扩展工具

相关推荐
先跑起来再说4 小时前
Git 入门到实战:一篇搞懂安装、命令、远程仓库与 IDEA 集成
ide·git·后端·elasticsearch·golang·intellij-idea
承渊政道7 小时前
Linux系统学习【Linux系统的进度条实现、版本控制器git和调试器gdb介绍】
linux·开发语言·笔记·git·学习·gitee
Doro再努力7 小时前
【Linux操作系统12】Git版本控制与GDB调试:从入门到实践
linux·运维·服务器·git·vim
摇滚侠10 小时前
MAC IDEA GIT 提交区显示了几个不存在的目录
git·idea
城东11 小时前
Git使用[远程仓库远端的head比本地和提交的head旧,其他人拉不到最新代码]
git·head·远程仓库远端·比本地和提交的head旧·其他人拉不到最新代码
何中应19 小时前
使用SSH地址拉取远程仓库代码报下面的错误
git
何中应20 小时前
Git本地仓库命令补充
git
sun00770021 小时前
执行repo sync -c -d -j4以后,提交未git push的代码看不到了。要怎么恢复?
git
胖虎11 天前
Git 一个本地仓库同时推送到两个远程仓库(详细教程)
git·多远程仓库·双远程仓库·git双远程·git备份
春日见1 天前
如何创建一个PR
运维·开发语言·windows·git·docker·容器