Git怎么进行Code Review_Git代码评审流程和最佳实践【进阶】

云磊酱_1073

云磊酱_1073

2026-03-28

508人浏览

原创

本地提交前用 git diff --cached 审查暂存区代码,结合 git status 检查误加文件,-w 忽略空格聚焦逻辑,启用 pre-commit 钩子保障格式,pr 描述需含 type/动机/验证方式,分支名用 type/scope/description 格式,评审时重点查依赖升级、副作用、函数签名变更及可逆性。

git怎么进行code review_git代码评审流程和最佳实践【进阶】

怎么在 Git 提交前做有效的 Code Review

Code Review 不是等 git push 完再看别人仓库里的 PR,真正高效的一轮评审,得发生在本地提交前。这时候你手上有完整的上下文,改了什么、为什么这么改、有没有漏掉测试,都一清二楚。

实操建议:

  • 用 git diff --cached 看即将提交的变更(也就是 git add 后还没 git commit 的内容),这是最干净的 review 切入点
  • 别跳过 git status —— 有时候误加了 node_modules/ 或临时调试日志,就藏在未暂存文件里
  • 对关键逻辑,用 git diff -w 忽略空格变化,聚焦语义差异;但注意:-w 会掩盖缩进错误,CI 可能报错
  • 如果团队有 pre-commit 钩子(比如 prettier + eslint),确保它已启用 —— 否则格式问题会干扰逻辑评审

PR 描述写什么才不算敷衍

“修复 bug” 或 “优化性能” 这类描述等于没说。Reviewer 打开 PR 第一眼看不到动机,就会卡住或直接问你,拖慢整个流程。

实操建议:

  • 第一行用 feat: / fix: / refactor: 开头(和团队约定一致即可),控制在 50 字内,说明「做了什么」
  • 正文必须包含「为什么」:Before 状态下哪里出问题(可贴错误日志片段,如 TypeError: Cannot read property 'id' of null),After 如何解决
  • 附上可验证方式:比如 “本地运行 yarn test:unit --testNamePattern=useAuth 通过”,或 “访问 /admin/users?role=editor 页面不再白屏”
  • 避免写 “详见 commit log” —— PR 描述是独立文档,不是 commit 的索引

Git 分支命名怎么避免混乱

分支名不是个人备忘录。fix-bug-2024、my-new-feature 这类名字在多人协作中毫无信息量,合并时连自己都记不清当初改了啥。

Conventional Git
Conventional Git

Conventional Commits v1.0.0 分支、工作树命名及提交信息规范,适用于 GitHub 与 GitLab 项目,用于创建分支和命名工作树等场景。

下载

实操建议:

  • 统一用 type/scope/description 格式,例如:fix/auth/token-expiry、feat/dashboard/export-csv
  • type 限定为几个常用值:feat、fix、chore、docs、refactor(不推荐 hotfix,它本质还是 fix)
  • scope 写模块或功能域,不是文件路径(用 auth,别用 src/utils/auth.js)
  • 禁止用数字编号代替描述,比如 fix/12345 —— Jira 编号放 PR 描述里,分支名要自解释

Review 时怎么快速定位风险点

没人会逐行读完 2000 行 diff。真正需要关注的是高风险模式:状态变更、副作用调用、边界条件、第三方依赖升级。

实操建议:

  • 先扫 package.json:如果有 "lodash": "^4.17.21" → "lodash": "^4.18.0",查 CHANGELOG 看是否含 breaking change
  • 搜 localStorage、sessionStorage、fetch、setTimeout 这类易出错关键词,确认是否有异常处理或清理逻辑
  • 对比前后函数签名:如果改了 getUser(id) → getUser(id, options),检查所有调用处是否传了默认值或适配了新参数
  • 留意新增的 console.log、debugger、console.table —— 它们不该出现在提交代码里,哪怕只是临时调试

最常被跳过的其实是「合并后行为是否可逆」:比如删了一个 API 路由,有没有 404 fallback?改了数据库 schema,migration 脚本能否回滚?这类问题往往到上线才发现。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

git

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

1975

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

2702

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

936

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

3019

7

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

529

3

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

2024.03.01

1658

6

登录token无效
登录token无效

登录token无效解决方法:1、检查token的有效期限,如果token已经过期,需要重新获取一个新的token;2、检查token的签名,如果签名不正确,需要重新获取一个新的token;3、检查密钥的正确性,如果密钥不正确,需要重新获取一个新的token;4、使用HTTPS协议传输token,建议使用HTTPS协议进行传输 ;5、使用双因素认证,双因素认证可以提高账户的安全性。

2023.09.14

12106

6

登录token无效怎么办
登录token无效怎么办

登录token无效的解决办法有检查Token是否过期、检查Token是否正确、检查Token是否被篡改、检查Token是否与用户匹配、清除缓存或Cookie、检查网络连接和服务器状态、重新登录或请求新的Token、联系技术支持或开发人员等。本专题为大家提供token相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.14

1465

5

token怎么获取
token怎么获取

获取token值的方法:1、小程序调用“wx.login()”获取 临时登录凭证code,并回传到开发者服务器;2、开发者服务器以code换取,用户唯一标识openid和会话密钥“session_key”。想了解更详细的内容,可以阅读本专题下面的文章。

2023.12.21

3237

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
vscode手册
vscode手册

共0课时 | 0人学习

Git 教程
Git 教程

共21课时 | 7.9万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.8万人学习