Phabricator评审流程(开发人员&项目经理篇)

. . 市科远软件技术开发分公司Phabricator评审流程版本0.1徐玉龙2015/1/14版本号：V0.1文档等级：参考手册说明A角色代码修改人：liming代码审核人：lihuaifang其他开发人：qiaozhiphabricator管理员:wuxiaonaB配置对于开发人员，需要进行phabricator客户端配置后才能触发提交前评审流程，详见Phabricator客户端部署（开发人员篇）.docx。其他人员如项目经理，直接在Phabricator上登陆即可使用。C使用phabricator前须注册有效账户，向对应的phabricator管理员申请权限，输入密码激活个人账户，会收到如下，输入密码即可使用。D本文档演示了最常见的phabricator提交前评审和提交后评审流程，开发人员熟悉了之后可灵活变化。提交前评审（Differential）步骤1：创建代码评审Liming修改了代码，将修改的文件提交评审:1)原始arc工具提交评审修改容见图1.1的svn diff命令结果，代码修改之后通过arc diff命令提交评审。arc diff命令会弹出文本编辑器，根据实际情况填写相关信息，重点是审核人（Reviewers必填字段，两个以上审核人用逗号分隔），CC抄送相关人。图1.1编辑器填好后保存退出（图1.2），则Phabricator自动创建审核任务并发送给相关人图1.22) karc工具提交评审使用karc diff创建评审,选择是否使用上次评审容作为模板,第一次操作不会出现此界面图1.3我们选择n,弹出nodepad+界面,容如下:图1.4图1.5按照svn提交规,填写模板,保存退出,如果项目中存在很多零时文件,会出现下面选项,一般选择n图1.7后续同上.3)图形界面创建评审鼠标选中要提交评审的文件夹,右键选择arcanist create图1.8图1.9图1.10步骤2：评审人进行代码评审Lihuaifang收到评审请求：抄送人Qiaozhi收到类似（抄送人没有审核权，仅仅知会到而已）:Lihuaifang收到后，登陆Phabricator，看到有一个新增评审任务（即提交前评审Differential），如图1.3。图1.3点开任务D8 test example明细如图1.4，lihuaifang觉得代码修改得有问题，给予驳回。图1.4步骤3:开发人员更新代码评审liming收到驳回：之后，Liming根据评审意见（和phabricator都可以看到lihuaifang具体审核意见），重新修改代码，并继续用arc diff命令添加再次修改的注释，保存退出后，怀芳收到再次修改的评审请求：1)arc工具更新评审Notepad+填写好更新说明,保存退出,即可2)karc diff工具更新评审,出现下面选项选择N即可3)图形界面更新评审选择要提交评审文件夹,右键选择arcanist update步骤4：评审人员再次评审代码lihuaifang登陆phabricator再次评审.图1.5如此直到评审通过，lihuaifang承受了该条修改，评审过程通过。步骤5：开发人员提交代码Liming收到评审通过后，可以用arc commit提交代码，phabricator自动关闭评审。1)arc工具提交代码arc commit revision D82)karc工具提交代码karc diff update D83)图形界面提交代码在svn工程下选择任意文件或者文件夹右键,选择arcanist commit图1.6回顾整个流程如下：图1.7提交后评审（Audit）相对提交前评审，提交后评审流程上更简单宽松，唯一的约束是代码评审人承受了该svn commit才能关闭该条评审。步骤1：开发人员提交代码并创建代码评审Liming修改了代码并svn commit，按照格式填写了Auditors: name1,name2(图2.1)，此时会自动触发Phabricator创建一条audit（即提交后评审任务）图2.1注：也可命令行E:test4jenkinscode svn ci -m Auditors:lihuaifang，效果相同。步骤2：评审人员进行代码评审Lihuaifang收到并登陆Phabricator查看修改。图2.2Lihuaifang认为修改有问题，予以驳回（填上具体的驳回原因），要求liming重新修改。图2.3步骤3：Liming收到，并登陆Phabricator查看lihuaifang的驳回意见（图2.4）。之后，liming重新与相关人员讨论并修改代码，或者通过跟lihuaifang交流（线上：通过phabricator；线下：面对面交流），最终达成共识不需要重新修改。图2.4步骤4：lihuaifang Accept，该条评审完毕。图2.514 / 14