什么是代码拉取请求
在团队协作开发中,你改完一段代码,总不能直接往主分支上提交吧?万一出问题,整个项目都可能瘫痪。这时候就得用“拉取请求”(Pull Request,简称 PR)。它不是直接合并代码,而是先提个申请:"我改了点东西,你看行不行?"
常见的平台比如 GitHub、GitLab、Gitee 都支持这个功能。写好一个 PR,不仅能提高代码质量,还能让同事快速理解你的改动意图。
写 PR 前的准备工作
确保你的本地分支是从最新的主分支拉出来的。比如你在 GitHub 上开发一个新功能,应该先更新 main 分支:
git checkout main
git pull origin main
git checkout -b feature/user-login改完代码后提交并推送到远程:
git add .
git commit -m "添加用户登录接口"
git push origin feature/user-login推完之后,去网页端就会看到一个“Compare & pull request”的提示按钮。
填写 PR 的关键内容
点击创建 PR 后,页面会要求你填标题和描述。标题要简洁明了,比如:feat: 添加用户登录 API 接口,让人一眼知道这是干啥的。
描述部分更重要。别只写“修了点东西”,那样别人还得一行行翻代码猜。建议分成几块写:
- 改动背景:为什么要做这次修改?比如“当前系统没有登录验证,需要补上”
- 具体变更:改了哪些文件,新增了什么逻辑
- 测试方式:怎么验证这个功能没问题?比如“启动服务后调用 /api/login,传入正确密码返回 200”
- 相关链接:如果有任务单或 bug 编号,可以附上 #JIRA-1234
一个清晰的描述能让审核人快速判断是否合入,省得来回问你。
给个实际例子
假设你修复了一个按钮点击无效的问题,PR 可以这样写:
标题:fix: 修复首页提交按钮无法触发事件的问题
描述:
## 背景
用户反馈点击首页的“立即提交”按钮没反应,排查发现事件绑定被误删。
## 修改内容
- 重新绑定 click 事件到 #submit-btn
- 添加防重复提交逻辑,防止用户连点导致多次请求
## 测试步骤
1. 打开首页
2. 点击“立即提交”
3. 查看控制台是否输出 "submit triggered"
4. 连续点击多次,确认只触发一次请求
## 关联任务
Closes #456这样的 PR 审核起来轻松多了,别人一看就懂你干了啥、为啥要改、有没有副作用。
其他小建议
PR 别太大。如果你一口气改了十个功能,别人看都看不完,容易拖着不审。最好拆成小块,比如“加字段”、“改样式”、“补校验”分开提三个 PR,每个都能快速过掉。
另外记得关注评论。有人提了意见,及时回复或修改。等对方说“LGTM”(Looks Good To Me),就可以点击合并了。
合完别忘了本地同步一下:
git checkout main
git pull origin main下一次开发就又从干净的状态开始了。