写点什么

关于 Pull Request 的十个建议

  • 2015 年 2 月 24 日
  • 本文字数:1543 字

    阅读完需:约 5 分钟

Pull Request 是 Bitbucket GitHub 等源代码托管系统为了方便开发者之间协作而提供的一个功能,它提供了一个用户友好的 Web 界面来帮助审查人员进行代码审查。开发人员可以通过 GitHub 发出 Pull Requests 要求请求他人将程序拉下来进行代码审查。一个好的 Pull Request 不仅仅只是代码的事情,还牵涉到代码审查者对代码的审查,所以开发者不仅要写出好的代码,还必须迎合审查者的审查工作,才能给使得自己贡献的代码顺利通过审查并合并到 master 分支。现对丹麦的程序员、软件架构师、独立顾问 Mark Seemann 在自己博客中发布的一篇题为《关于Pull Request 的十个建议》的文章进行一个全面的整理,以供读者阅读和参考。具体内容如下:

1. 进行较小的 Pull Request

一个小且集中的 Pull Request 会使得提交的代码更加容易通过审核。据 Mark Seemann 根据自己的经验透漏,对提交代码进行审查所花费的时间是随着代码大小呈指数增长,而非线性增长;Pull Request 多大才合适与 Pull Request 做了什么相关,最好少于 12 个文件的改变。如果 Pull Request 非常大,审查者就需要安排连续、相对比较长的时间进行审查,就会造成审查过程的延迟。

2. 每个 Pull Request 只做一件事

就如软件设计模式中的单一责任原则所指:一个类只负责一个功能领域中的相应职责,因此一个Pull Request 也应只关注一件事情。如果一次Pull Request 做了多件事情的话,将会增加审查过程的延迟、审查被拒绝的可能性。

3. 注意代码行的字数, 最好少于 80 个字

代码审查者会使用不同的审查工具来审查提交的代码,并且 GitHub 和 Stash 还提供了不同形式的视图,这样就使得代码审查者能通过不同视图非常方便来审查用户的提交。如果代码行比较宽的话,审查者就不能在一个屏幕或者半个屏幕中来阅读代码,不得不拖动滚动条来阅读代码。为了使得代码比较容易审查,每行代码最好少于 80 个字符。

4. 避免重新格式化代码

就算自己觉得应该改变当前代码的格式以适合自己的风格,但是请不要这么做。在源代码上,用户对每个字节的改变将会在不同的审查视图显示出来。有些审查者会选择忽略空格改变,但是有些审查者会审查这些代码,对这些格式化引起的代码审查属于不必要的审查。如果真需要解决空格问题的话,就需要在其他文件里移动代码、改变格式或者对代码做其他样式改变,并在 Pull Request 注释中给出相应的说明。

5. 确保代码能够编译通过

在提交 Pull Request 时,应该首先在自己的电脑上进行编译构建。在编译构建过程中,务必注意编译过程出现的警告,要把警告当作错误来对待,这些警告可能不会阻止编译,就有可能被忽略。然而,当用户 Pull Request 操作引起了很多编译警告的话,代码审查者就有可能拒绝对应的提交。

6. 确保提交的代码能够通过所有测试

即使问题代码已经做了自动化测试,但是在提交 Pull Request 时,也要务必保证针对代码的所有测试都必须通过。

7. 添加测试

为代码建立测试规则,即使出现问题的代码已经做过了自动化测试,最好也要为自己提交的代码也做下测试。

8. 记录下自己提交的原因

利用文档对代码进行注释、对自己的代码直接进行注释、利用版本控制器提供的提交信息功能备注信息、利用 Pull Request 管理系统(如 GItHub 或者 Stash)添加自定义的 Pull Request 注释信息。

9. 编写符合编码规范的代码

按照代码正确性规则编写代码,并附上有效的代码注释、提交信息、Pull Request 信息等。

10. 避免颠簸

不同审查者对 Pull Request 有可能具有不同的观点,这就会导致颠簸的情况,就需要用户移除冲突的提交和推送修改的分支,并备注有效的信息。


感谢郭蕾对本文的审校。

给InfoQ 中文站投稿或者参与内容翻译工作,请邮件至 editors@cn.infoq.com 。也欢迎大家通过新浪微博( @InfoQ )或者腾讯微博( @InfoQ )关注我们,并与我们的编辑和其他读者朋友交流。

2015 年 2 月 24 日 00:438980
用户头像

发布了 46 篇内容, 共 47.7 次阅读, 收获喜欢 13 次。

关注

评论

发布
暂无评论
发现更多内容

深度学习在物理层信号处理中的应用研究

华为云开发者社区

学习 模型 物理层

Linux角度仰视Goroutine的GMP

ninetyhe

Java Linux 多线程与高并发 Go 语言

干货分享!用心满满:面试前必知必会的二分查找及其变种

比伯

Java 编程 架构 面试 计算机

为什么阿里人能够快速成长?看完他们Java架构进化笔记,我秒懂!

Java架构追梦

Java 学习 架构 面试 成长笔记

这是我见过最好的算法笔记,四面字节拿offer的感悟

互联网架构师小马

Java 字节跳动 数据结构 面试 算法

鹅厂大佬亲身经历证明,一周上线百万级并发系统

Java架构师迁哥

三分钟看懂快速开发,常用软件快速开发平台速览

Marilyn

敏捷开发 快速开发 企业开发 企业应用

《Web自动化》基础知识脑图

无个性不签名

Web

王者级别的Java多线程技术笔记,我愿奉你为地表最强!

Java架构师迁哥

工商银行基于 Dubbo 构建金融微服务架构的实践-服务发现篇

阿里巴巴云原生

云原生 dubbo 中间件 案例分享 CloudNative

InfoQ 内容推荐位资源限时开放

乐白

InfoQ 资源

WebRTC SDP 详解和剖析

阿里云视频云

阿里云 音视频 WebRTC 视频云 流媒体传输

CloudIDE插件开发实战:教你如何调试代码

华为云开发者社区

ide 开发 Cloud

阿里P8告诉你:微服务架构设计解决了什么问题

互联网架构师小马

Java 编程 架构 微服务 软件开发

前端开发还可以这么玩?元数据实践分享

华为云开发者社区

前端 元数据 组件 ROMA 业务流

anyRTC 联合 vInClass 打造在线教育上课模式

anyRTC开发者

音视频 WebRTC 在线教育 RTC

5G多输入多输出技术,到底是个啥东东?

华为云开发者社区

5G 输入 输出

想拿到10k-40k的offer,这些技能必不可少!作为程序员的你了解吗?

Crud的程序员

Java 程序员 技能

理解Python协程的本质

Justfly

Python 协程 异步 Async 异步编程

多活/多机房的几种实现方式与重点

Justfly

高可用 跨机房 数据同步 异地多活容灾

流动性挖矿系统APP开发|流动性挖矿软件开发

系统开发

一次产品影响地图的探索之旅

Bruce Talk

敏捷 Agile Product Owner 影响地图

架构师训练营第 1 期 第 11 周作业

李循律

极客大学架构师训练营

基于RTMP数据传输协议的实时流媒体技术研究(论文全文)

程序员小灰

音视频 ffmpeg 流媒体 RTMP webrtc、

研发管理:敏捷研发下周报的价值

云原生实验室

云原生 敏捷 研发管理 周报

架构探索:事务处理一

李海明

拆解增长黑客之实战(一):获客与激活

懒杨杨

增长 产品运营

揭秘 VMAF 视频质量评测标准

阿里云视频云

视频 图像处理

mongodb 源码实现系列 - command 命令处理模块源码实现二

杨亚洲(专注mongodb及高性能中间件)

MySQL mongodb 分布式数据库 源码刨析 分布式数据库mongodb

深入灵魂的考验,每行注释都是灵魂的单例模式,源码+实例降临

小Q

Java 学习 架构 面试 设计模式

全球熵ETV系统APP开发|全球熵ETV软件开发

系统开发

Flutter 自动化测试

Flutter 自动化测试

关于Pull Request的十个建议-InfoQ