http://www.cocoachina.com/gamedev/misc/2013/0227/5728.html
这篇文章的内容由ThoughtBot在github上官方主页提供,指导你如何在github上进行代码审查和如果让别人审查自己的代码。
针对所有人的审查
•接受这样的事实:很多编程上的主张都是一种个人观点。应该讨论它们的利与弊,提出你的倾向观点,迅速的达成一种解决方案。
•提问,而不是命令。(“把这个变量命名成:user_id你觉得怎样?”)
•请求说明。(“我不明白。你能解释一下吗?”)
•避免代码的归属之争。(“我的”,“不是我的”,“你的”)
•避免使用一些会被认为是有关人身特征的词语。(“笨蛋”,“愚蠢”)要把所有人都看作是有魅力的、聪明的、善意的。
•要明确。要记着并不是每个人都能理解你的意图。
•要谦虚。(“我不能确定——我们来分析一下。”)
•不要用夸张修辞语。(“总是”,“从不”,“永远”,“毫无…”)
•不要讽刺。
•展现真实的你。如果你不是幽默型的人,不喜欢使用一些表情符号或动画gif图,不要勉强。如果你是这种人,请自信的发挥。
•如果有太多的“我不理解”或“另一种方案:”的评论,请专门针对这个人进行交流。可以把你们线下的交流总结成一个帖子附在后面。
让别人审查你的代码
•对审查者的建议表示感激。(“谢谢提醒。我会把它改正。”)
•理解审查是对事不对人。审查的是你的代码,而不是你。
•解释为什么代码写成这样。(“因为xxx原因我才写成这样。如果我把这个类/文件/方法/变量改个名会更清晰些吗?”)
•整理所作的改动,在以后的迭代中重构它们。
•在做修改的版本上注明代码审查的链接。(“Ready for review: http://github.com/organization/project/pull/1″)
•push提交要基于最早的一轮反馈,并形成一个独立的分支。等这个分支上的任务完全完成了再合并。这让审查者能够根据早先的反馈找到你的单独的更新。
•努力站在审查者的立场上理解。
•争取回复每个评论。
•直到最后一个人退出登录后再合并分支。
•直到持续集成测试(TDDium, TravisCI,等)告诉你这个分支的测试套件通过后再合并分支。
代码审查的过程
先要清楚你提交的代码的必要性(是修补bug,提升用户体验,重构…),然后:
•针对你感觉非常好的地方以及不是很好的地方与作者交流。
•找出既能解决问题又能简化代码的方法。
•如果讨论变得过于哲学或理论,把讨论转到线下,做成一个有规律的每周五下午的讨论会。同时,是否采用你提出的实现方案,让作者自己做决定。
•提出你的实现方案,但要表现出作者也在考虑这种方案。(“你觉得这里用一个自定义校验如何?”)
•努力理解作者的立场。
•pull请求登出时,加一个或“可以合并了”的注释。
关于程序风格样式的评论注释
审查者应该对那些不符合样式指导的地方进行注释。例如这样注释:
如果你不同意某个指导原则,请在指导repo里创建一个问题,而不要再代码审查中争论它。同时,请运用这个指导原则。
相关推荐
"App侵权开发者如何向苹果AppStore或GooglePlay应用商店投诉" 本文将详细介绍App侵权开发者如何向苹果AppStore或GooglePlay应用商店投诉,涉及到知识产权的保护、版权和商标的概念、侵权行为的处理方法和投诉流程等...
App_store发布流程详解 本文将详细介绍如何将APP发布到App Store的步骤,涵盖证书的导出、App ID的申请、发布证书的申请等重要知识点。 一、证书的导出 要将APP发布到App Store,首先需要导出证书。在苹果的...
随着移动互联网的发展,应用程序(App)已成为企业和个人接触用户的重要渠道之一。对于iOS平台上的开发者来说,如何有效地推广自己的应用显得尤为重要。苹果公司为此制定了《App Store:开发者营销广告指南》,这份...
App Store模式,自2008年由苹果公司推出以来,已成为全球移动应用分发的重要典范,引领了移动互联网行业的创新和发展。本报告将深入探讨App Store的各个方面,包括其定义、业务模式、应用内容的分析以及背后的商业...
在介绍App Store上传流程之前,需要了解App Store的开发者账号注册、...在整个过程中,开发者应该密切关注App Store Connect的状态更新,以便了解应用程序审核的最新进展,并根据苹果公司的反馈作出相应的修改和更新。
它允许个人开发者获取计划资源,并且在上传应用到App Store时,"销售者"一栏会显示个人的名字。 2. **公司iOS开发者计划** - 同样是$99/年,适合有团队协作需求的公司。团队成员可以被添加并共享项目资源,而且在...
iOS App Store 上架流程是 iOS 开发者发布应用程序到 App Store 的必要步骤。下面将详细介绍 iOS App Store 上架流程图文详解 2021 版。 一、填写 App Store 发布信息 在 Apple Developer 首页,点击进入 App ...
CNAPS大额行号查询 联行号和地址查询
Apple为自己的官方应用如AppStore和iTunes定义了特定的URL Scheme,使得开发者可以通过特定的URL来启动这些应用。例如,`itms-apps://` 和 `itms-books://` 分别用于打开AppStore和iBooks。 ### 2. 跳转到AppStore...
**envi-app-store** 在IT领域,ENVI(Environment for Visualizing Images)是一款广泛使用的遥感图像处理和分析软件。它的强大功能在于提供了一系列高级工具,帮助用户进行图像分类、特征提取、大气校正等复杂任务...
因此,App Store 已成长为一个激动人心且充满活力的生态系统,正为数百万的开发者和超过十亿的用户提供服务。不管是开发新手,还是由经验丰富的程序员所组成的大型团队,我们都非常欢迎您为 App Store 开发 app,并...
【标题】"仿安智市场的appStore Demo"是一款模拟应用商店功能的演示程序,它旨在为开发者提供一个参考模板,以便他们能理解并构建类似的应用市场平台。这个Demo可能包括了用户界面设计、应用程序搜索、分类展示、...
在 App Store 上架流程中,需要经过多个步骤,包括拥有自己的苹果开发者账号、创建相关证书和配置文件、创建 Bundle ID、创建配置文件等。下面将详细介绍每个步骤的内容。 第一步:拥有自己的苹果开发者账号 苹果...
《App Store 审核指南》是苹果公司针对iOS开发者发布的一款重要文档,旨在规范和指导开发者如何设计、开发和提交应用程序到App Store的过程。这份2013年1月29日的中文版审核指南,详细阐述了苹果对应用程序的各种...
在移动互联网时代,二手市场APP已成为许多人处理闲置物品、寻找实惠商品的重要平台。"基于UNI-APP的仿转转二手市场APP页面模板"是一个开发项目,旨在为开发者提供一个快速构建类似转转APP的用户界面的工具。这个模板...
在iOS应用开发的世界中,有时候由于各种原因,开发者可能需要将已经上线并成功通过Apple App Store审核的应用下架。这个过程并非一键操作,而是需要在iTunes Connect平台上进行一系列设置更改。以下是一份详细的步骤...
·APP开发者工具及包含的环境文件 ·APP生成视频教程 `APP控制端安装使用视频教程 所有文件压缩包总大小2.33G APP源代码说明: APP源代码包含安卓和苹果IOS的源文件,可以编译生成两个系统所需要的软件安装包 可以...
App Store模式分析报告 1. App Store概述 App Store是由苹果公司推出的数字应用程序商店,它为iOS设备(如iPhone、iPad)用户提供了一个集中下载和购买应用程序的平台。自2008年7月上线以来,App Store彻底改变了...