[讲解]fisheye界面按钮功能详细说明以及代码评审详述

Fisheye 注:Crucible+Fisheye+JIRA三者集成 目 录 一、 浏览 Crucible 界面 .................................................................. 3 二、 设置用户信息........................................................................... 4 1. Reviews Tab.............................................................................. 5 2. Author Mapping Tab .................................................................. 5 三、 角色及状态的改变.................................................................... 6 四、 评审过程.................................................................................. 8 1. 创建评审.................................................................................. 8 2. 添加评审................................................................................ 11 3. 开始评审................................................................................ 13 4. 进行评审................................................................................ 13 5. 回复评审................................................................................ 14 6. 完成评审................................................................................ 17 1) 完成评审的操作 .............................................................. 17 2) 发送评审邮件.................................................................. 19 7. 总结 初级经济法重点总结下载党员个人总结TXt高中句型全总结.doc高中句型全总结.doc理论力学知识点总结pdf 与关闭评审 ..................................................................... 22 8. 删除已取消的评审.................................................................. 25 9. 更改评审的项目 ..................................................................... 25 五、 使用收藏夹 ............................................................................ 29 1. 添加一个评审至我的收藏夹。 ................................................ 29 2. 添加一条评审意见至我的收藏夹............................................. 29 30 3. 添加一个项目至我的收藏夹.................................................... 4. 添加一个用户至我的收藏夹.................................................... 31 5. 添加某个文件或文件夹至我的收藏夹...................................... 32 6. 添加一个代码库至我的收藏夹 ................................................ 32 7. 查看我的收藏夹 ..................................................................... 32 8. 重命名我的收藏项.................................................................. 33 9. 删除我收藏夹中的某项........................................................... 34 六、 Crucible中的快捷键 ............................................................... 34 1. 常用的快捷键: ..................................................................... 34 2. 评审意见导航快捷键:........................................................... 35 3. 文件导航快捷键:.................................................................. 35 一、 浏览 Crucible 界面 当你进入Crucible界面，首先看到的就是 Dashboard 界面, 在这下面显示了最近的一些活动(SVN提交，评审): 截图: Dashboard Crucible界面的说明如下表所示: 标题 功能 出现的位置 Dashboard 显示与你相关的系统活所有页面 Tab 动与审查 Source Tab 显示你连接的源代码库只有当FishEYE被用于 的所有活动 Crucible时 Projects Tab 显示具体项目的评审与所有页面 内容 People Tab 显示用户 所有页面 Reviews Tab 显示评审 所有页面 左侧导航栏 导航栏显示在屏幕的左侧面，这里主要显示具体的过滤器。具体过滤元件，请查看左侧导航栏。 左边的导航可以隐藏侧面边栏或点击蓝色的'information'图标显示 二、 设置用户信息 如果要查看您的用户配置，登陆Crucible，并单击用户菜单(显示你的用户名的地方)，选择“Settings”项。 截图: Settings 参照 FishEye documentation文档中关于'Display settings', 'Profile and Email' and 'Watches'. 1. Reviews Tab 如果设置了SMTP server ，Crucible中的活动都会通过邮件发送给相关的人。 你可以设置下列选项，来指定在哪个电子邮件将被发送阶段。 State change 默认'Yes'. Crucible通过不同的状态: 'Draft', 'Under Review'. 当状态改变时就发送邮件. Comment added 默认 'Yes'. 当添加COMMENT时就发送邮件. Participant 默认'Yes'. 邮件只发送给 Moderator 当所有评finished 审员都 completed their review. General message 默认'Yes'.处于“Under Review”状态的评审员， 添加或删除评审时，发送邮件。 My actions 默认 'No'. 如果设置为 'Yes', 你执行的任何 一项审查活动都会发邮件给你自己。 2. Author Mapping Tab The 'Author mapping' 允许你们进行关联。 用户名可以在不同的仓库中，Crucible会检查用户名是否匹配。 三、 角色及状态的改变 Roles in Crucible Author Creator/Moderator Reviewer User Status Classifications in Crucible Draft Under Review Summarized Closed Abandoned Dead Crucible中的角色 Author(作者) 作者是主要负责人，是审查结果采取行动的负责人。在绝大多数的情 况下，是由评审提出者修改代码。 Creator/Moderator(创建者/裁判员) 创建者就是创建一个评审(REVIEW)。在大多数的情况下，创建者也 是裁判员 moderator. 裁判员就是负责评审，和批准审查的人(可以创建，下载TXT，发邮件，REOPEN，CLOSE，总结)。 在审查结束后，由裁判员来总结和关闭审查。默认情况下，裁判员是创建者。 Reviewer(评审员) 评审员可以提出意见，并说明他们完成审查。而裁判员是可以对评审进行评论。 User 用户可以使用Crucible. Crucible中评审的状态分类 Draft(草稿) Draft 评审是尚未完成或释放到评审中。 Under Review(正在评审) Under Review可以进行评审或等待评审，等待进行总结。 Summarized Summarized 是过去的评审阶段。裁判员仍然可以添加结论或意见。 Closed Closed 是说明这个评审已完成。 Abandoned Abandoned 是一个垃圾评审。正在创建的评审必须被放弃才能被删除(已创建的评审在任何状态都可被删除)。 四、 评审过程 Creating a Review (创建评审) Adding Reviewers (添加评审) Issuing a Review (开始评审) Performing the Review (进行评审，回复评审，完成评审) Summarising and Closing the Review (总结关闭评审) Deleting an Abandoned Review (删除或取消一个评审) Moving a Review to Another Project(移动一个评审到另一个项目中) 1. 创建评审 在Crucible中创建评审 打开Reviews Tab，选择屏幕右上角的Tools菜单，然后再选择Create Review. 截图: 创建一个评审(创建评审的第一步:下图是从FishEYE中创建评审，从Crucible中创建评审请参照上文所示操作步骤。) 截图: 选择一个项目(创建评审的第二步:选择需要评审的项目) 截图: Crucible管理文件对话框(创建评审的第三步:选择需要评 审的文件或内容) 截图: 在Crucible中创建评审(创建评审的第四步:如需要跟Jira 中Issues关联，请在[Statement of objectives]中写上Issues的 关键字) 补充说明:在JIRA中创建评审 截图:从JIRA中创建评审 2. 添加评审 打开Reviews界面，选择新建的评审，单击右上角的Start Review，开始添加评审。 截图: Crucible中新建的评审，该评审的为Draft状态(点击Start Review后，为Under Review状态) 评审员可以随时删除，删除评审员的操作如下: 以评审的创建者或裁判员的身份登陆Crucible. 打开需要更改评审员的评审. 单击'Edit Review' 按钮: 找到要删除的评审员，在旁边的复选框中去掉选择: 单击 'Save'按钮，保存更改. 这个评审员就会从该评审中删除掉，并以邮件的形式通知他. 评审员只能由创建者或裁判员删除. 你不能从评审中删除创建者和裁判员. 3. 开始评审 开始评审:Crucible中被称为开始评审，它意味着评审可以正式开始.只有裁判员才能批准评审(开始评审)，作者可以推荐评审，而评审员则只能评审(这个评审的动作可以在评审未结束之前的任何时候)进行。 截图: 批准评审 请注意，只有作者才能推荐评审，裁判员才能批准评审。 4. 进行评审 如何查找和管理你相关的评审, 浏览你的评审，在 'Dashboard'一栏中。 浏览所有的评审，在 'Reviews' 一栏中。 当一个文件在评审的过程中改变时，我们就要决定哪些需要评审。 Crucible没有规定如何和怎样评审代码。它只是提供了一种机制， 记录意见。 截图: 代码库版本 从 'File Outdated'菜单，可以选择查看更新的文件的最新版本，或 者对这个评审添加最新的版本: 截图: 'File Outdated' 菜单 5. 回复评审 在评审过程中添加评审，也可以回复其别人的评审。 截图: 查看现有评审意见 增加一条新的评审意见 若要添加评审意见，适用于整个评审，可以选择左边菜单栏中的“Review Comments”，然后单击图标: 若针对版本/更新来添加评审，可以从左边导航栏中选择这个文件，然后单击图标: 要添加一个源代码级的意见，从左侧导航栏中选择这个文件，在源代码视力中，单击一行代码。你可以单击并拖动以选择一行或多行。注 释将悬停在最后一行选定的源代码后面。 要选择多行，请按住Alt键。 回复一条评审, 在该评审的底部单击 'Reply'按钮. 只有拥有评审权限的用户，才能添加评审. 关于flagging defects. 截图: 添加评审 草稿(Draft)评审 可以将你自己刚创建的评审作为一个草稿.当你完成评审时，系统会提示你 :是否发送\取消\编辑你的草稿评审,. 截图: 草稿(Draft) 评审 缺陷标识 作为被评代码的作者，你可以自己为某行有缺陷的而未被他人评审的代码打上缺陷标识。 截图: 缺陷标识 6. 完成评审 评审员已经对这个代码再也没有任何评审的意见时，评审员可以将对这个评审作一个完成标识，以方便其它评审员\作者\裁判员参考。 1) 完成评审的操作 为了完成评审员自己的评审,可以单击屏幕右上方的 'Complete' 按钮,紧挨 'Tools' 菜单: 只有评审员拥有 'Complete'权限. 评审员可以设置:当完成评审时，以邮件的方式告知裁判员。 当评审员完成评审后，评审员仍然可以添加评审，直到裁判员总结了 评审;而裁判员总结\关闭评审时，不需要所有评审员都完成评审。 如果评审员有未完成的评审或草稿评审，当评审员完成评审时，系统会提示该评审员。 截图: 草稿(Draft)评审的提示。 截图: 完成评审 2) 发送评审邮件 你可以将你的评审意见，以邮件形式告知他人。这样可以让他人更快的了解你的评审活动，或监督你的评审活动的内容。 通过电子邮件发送评审意见。 在Crucible中,打开该评审. 从 'Tools' 菜单中，选择 'Email Review'(见截图1). 将出现 'Recipients'页面(见截图2): 'To:' 可以输入多个电子邮件，以逗号分隔. 'Recipients:’ 你可以输入Crucible实例名，以将他们添加到通讯 组. 你也可以简单地选择 'Send to Review Participants' 复选框，包括所有参与评审的评审员. 单击'Next' 按钮. 将出现‘message’页面(见截图3): 完成相关信息后, 单击'Send' 按钮. 将出现 'Status' 页面(见截图4),确认邮件是否发送成功. 如果用户没有登陆Crucible，是不能发送邮件的,但是可以以文本形式查看评审意见. 截图 1: 'Email Review' 截图 2: 'Recipients' 页面 截图 3: 'Message' 页面 截图 4: 确认邮件是否发送成功 7. 总结与关闭评审 裁判员可以在任何时候对评审进行总结与关闭操作。 通常地, 裁判员都是等所有评审员都完成评审后，才进行总结与关闭操作. 总结评审: 选择屏幕右上角的'Summarize'按钮. 可以进入评审总结页面. 如果没有评审意见了，单击'Close Review' 按钮;否则，单击 'Continue Without Closing'按钮. 截图: 'Summarize' 按钮 该图标标识:这个评审还未完成。从上图我们可以看出:Geoff Crain 没有完成评审，因为他旁边还有这个绿色的图标。而这时，裁判员总结或关闭评审，将会看到一些提示信息。 虽然有未完成评审的评审员，但裁判员仍然可以总结或关闭评审。 一旦评审成为总结状态，裁判员可以添加评论的摘要，如成果任务等。 截图: 总结评审 截图:关闭评审 这个总结会发送给所有参与者，且在上方会显示 close或Reopen按钮. 只有裁判员才可以对评审进行总结，其他参与评审者没有这个权限。即裁判员拥有'last word'权限. 处于 'Summarize' 状态的评审，可以被关闭. 处于 'Summarize' 或 'Closed' 状态的评审，可以被裁判员 re-opened. 裁判员Re-open评审之后，评审变为 'Under Review' 状态, 这时就允许所有参与者对该评审进行评审. 我们也可以不用Re-opened一个评审，而是创建一个新的评审，将新评审父评审指向这个评审. 8. 删除已取消的评审 删除的评审不能被恢复。 删除已取消(dead)的评审，操作如下: 从’Dashboard'页面, 单击左侧导航栏中的'My Abandoned Reviews'. 将出现一个已取消评审的列表. 单击你想要删除的评审. 将显示这个评审的详细信息,从 'Tools'菜单中选择 'Delete'.这个评审就被删除掉了. 截图:在Crucible中删除评审 9. 更改评审的项目 你可以更改已创建评审的项目: 打开评审.单击 'Edit Review'. 在'Project'中， 选择一个新的项目. 单击 'Done' 按钮. 截图: 更改评审的项目 Dashboard 页面简介 截图: Crucible中的Dashboard页面 默认情况下，这个页面显示所有用户相关的所有活动。这里的所有活动都与Crucible有关, 比如提出评审意见, 打开或关闭评审, 提交文件至代码库,或更新Jira上的Issues。 Reviews栏:根据评审的状态，对所有与你相关的评审进行分类总结。 To Review 需要进行评论的评审 Require My 当你被指定为裁判员或作者时，你可以推荐该评Approval 审，这类显示的是你所有推荐的评审. To Summarize 当你被指定为裁判员时，这类显示你已进行总结的 评审. Out For Review 当前正在进行审查的评审。 Drafts 这些评审已被创建，但尚未由裁判员批准。需要 'Approval' 或 'Require Approval'. Open 所有打开的评审，所有参与者均可进行评审。 Closed 所有已关闭的评审。 Abandoned 已取消的评审。 右边栏: 标签 子项 Activity Tab 子项: All Activity — 显示所有活动。 Commits — 显示提交信息。 Reviews — 显示评审。 Issues — 显示JIRA issues. Show/Hide My Activity — Show/hide你自 己的活动. Show/Hide Revisions — Show/hide 其他 人的活动. Earlier / Later Activity (arrow buttons). Reviews Tab 子项: (显示过滤器的结果) RSS — 从当前的选择打开相应的RSS. Favourites Tab 子项: 无. (显示你收藏的所有内 容.) 五、 使用收藏夹 1. 添加一个评审至我的收藏夹。 要添加评审至我的收藏夹，将鼠标移至评审的名称上，将出现一个如截图所示的菜单。在该菜单的右上角选择'Tools' 菜单.再选择 'Add Star'. 则这个评审就被添加至我的收藏夹。 截图: 添加一个评审至我的收藏夹 2. 添加一条评审意见至我的收藏夹 打开该评审，在需收藏的评审意见的右下方，单击 'Add Favourites',则该评审意见就被添加至我的收藏夹。 截图:添加一条评审意见至我的收藏夹 3. 添加一个项目至我的收藏夹 进入'Projects' 栏. 单击需收藏的项目前的灰色五角星，五角星变黄，则项目被成功地加入我的收藏夹. 截图: 添加一个项目至我的收藏夹 4. 添加一个用户至我的收藏夹 进入“People”栏，选择需收藏的用户，将鼠标移至该用户上，将出现如截图所示浮图，然后选择 'Follow'. 则该用户就被添加至我的收藏夹. 截图:添加一个用户至我的收藏夹 5. 添加某个文件或文件夹至我的收藏夹 进入 'Source' 栏. 选择需收藏的文件或文件夹，单击灰色五角星， 五角星变黄。则该文件或文件夹被添加至我的收藏夹。截图: 添加一个文件或文件夹至我的收藏夹 6. 添加一个代码库至我的收藏夹 进入'Source' 栏. 单击需收藏的代码库前的灰色五角星，五角星变黄。则该代码库被添加至我的收藏夹。 截图: 添加一个代码库至我的收藏夹 7. 查看我的收藏夹 从 'Dashboard'栏中的选择 'Favourites' 栏。 截图: 查看我的收藏夹 8. 重命名我的收藏项 单击需重命名的收藏项前的黄色五角色，将出现 'Update Favourites' 菜单. 在 'Name' 框中输入名字，并单击 'Save label' 按钮. 则该收藏项被重命名。 截图: 重命名我的收藏项 9. 删除我收藏夹中的某项 单击需重命名的收藏项前的黄色五角色，将出现 'Update Favourites' 菜单，单击 ' Remove'' 按钮. 则该收藏项被删除。 截图:从我的收藏夹中删除某项 六、 Crucible中的快捷键 1. 常用的快捷键: 键 功能 ? 打开Crucible中的快捷键的参考列表。 escape 关闭快捷键的参考列表。 alt 按住ALT键，并拖动鼠标以选择多行源代码内容，来进行 多行评审. shift + f 全屏模式切换 2. 评审意见导航快捷键: 键 功能 n 转到下一个评审意见。 p 转到前一个评审意见. shift + p 转到第一个评审意见 . shift + n 转到最后一个评审意见 . l 转到下一个评审意见(跳过回复). h 转到前一个评审意见(跳过回复). ] 转到下一个未读评审意见。. [ 转到前一个未读评审意见. r 回复评审意见. m 评审意见标识，读/未读 状态的切换. 3. 文件导航快捷键: 键 功能 j 转到下一个文件 k 转到前一个文件 shift + k 转到第一个文件 shift + j 转到最后一个文件 u 转到下一个未评审的文件。 i 转到前一个未评审的文件。 y 设置文件评审，并转到下一个未评审的文件. shift + y 切换文件的状态: reviewed/unreviewed. e 展开当前文件 c 收缩当前文件 shift + e 展开所有文件 shift + c 收缩所有文件