fisheye界面按鈕功能詳細說明以及代碼評審詳述

1、Fisheye界面按鈕功能詳細說明以及代碼評審詳述 注：Crucible+Fisheye+JIRA三者集成目 錄一、瀏覽 Crucible 界面3二、設置用戶信息41.Reviews Tab52.Author Mapping Tab6三、角色及狀態(tài)的改變6四、評審過程81.創(chuàng)建評審92.添加評審113.開始評審134.進行評審135.回復評審146.完成評審171)完成評審的操作172)發(fā)送評審郵件197.總結與關閉評審238.刪除已取消的評審269.更改評審的項目26五、使用收藏夾301.添加一個評審至我的收藏夾。302.添加一條評審意見至我的收藏夾313.添加一個項目至我的收藏夾314.添

2、加一個用戶至我的收藏夾325.添加某個文件或文件夾至我的收藏夾336.添加一個代碼庫至我的收藏夾337.查看我的收藏夾338.重命名我的收藏項349.刪除我收藏夾中的某項35六、Crucible中的快捷鍵351.常用的快捷鍵：352.評審意見導航快捷鍵：363.文件導航快捷鍵：36一、 瀏覽 Crucible 界面當你進入Crucible界面，首先看到的就是 Dashboard 界面, 在這下面顯示了最近的一些活動（SVN提交，評審）：截圖： Dashboard Crucible界面的說明如下表所示： 標題 功能出現的位置Dashboard Tab 顯示與你相關的系統(tǒng)活動與審查 所有頁面Sou

3、rce Tab 顯示你連接的源代碼庫的所有活動只有當FishEYE被用于Crucible時Projects Tab 顯示具體項目的評審與內容所有頁面People Tab 顯示用戶所有頁面Reviews Tab 顯示評審所有頁面左側導航欄導航欄顯示在屏幕的左側面，這里主要顯示具體的過濾器。具體過濾元件，請查看左側導航欄。左邊的導航可以隱藏側面邊欄或點擊藍色的'information'圖標顯示二、 設置用戶信息如果要查看您的用戶配置，登陸Crucible，并單擊用戶菜單（顯示你的用戶名的地方），選擇“Settings”項。截圖: Settings參照 FishEye documen

4、tation文檔中關于'Display settings', 'Profile and Email' and 'Watches'.1. Reviews Tab如果設置了SMTP server ，Crucible中的活動都會通過郵件發(fā)送給相關的人。你可以設置下列選項，來指定在哪個電子郵件將被發(fā)送階段。State change 默認'Yes'. Crucible通過不同的狀態(tài): 'Draft', 'Under Review'. 當狀態(tài)改變時就發(fā)送郵件. Comment added 默認 'Yes

5、'. 當添加COMMENT時就發(fā)送郵件. Participant finished 默認'Yes'. 郵件只發(fā)送給 Moderator 當所有評審員都 completed their review. General message 默認'Yes'.處于“Under Review”狀態(tài)的評審員，添加或刪除評審時，發(fā)送郵件。 My actions 默認 'No'. 如果設置為 'Yes', 你執(zhí)行的任何一項審查活動都會發(fā)郵件給你自己。2. Author Mapping TabThe 'Author mapping

6、9; 允許你們進行關聯(lián)。用戶名可以在不同的倉庫中，Crucible會檢查用戶名是否匹配。三、 角色及狀態(tài)的改變Roles in Crucible Author Creator/Moderator Reviewer User Status Classifications in Crucible Draft Under Review Summarized Closed Abandoned DeadCrucible中的角色Author（作者）作者是主要負責人，是審查結果采取行動的負責人。在絕大多數的情況下，是由評審提出者修改代碼。Creator/Moderator（創(chuàng)建者/裁判員）創(chuàng)建者就是創(chuàng)建一個

7、評審（REVIEW）。在大多數的情況下，創(chuàng)建者也是裁判員 moderator. 裁判員就是負責評審，和批準審查的人（可以創(chuàng)建，下載TXT，發(fā)郵件，REOPEN，CLOSE，總結）。在審查結束后，由裁判員來總結和關閉審查。默認情況下，裁判員是創(chuàng)建者。Reviewer（評審員）評審員可以提出意見，并說明他們完成審查。而裁判員是可以對評審進行評論。User用戶可以使用Crucible.Crucible中評審的狀態(tài)分類Draft（草稿）Draft 評審是尚未完成或釋放到評審中。Under Review（正在評審）Under Review可以進行評審或等待評審，等待進行總結。SummarizedSumm

8、arized 是過去的評審階段。裁判員仍然可以添加結論或意見。ClosedClosed 是說明這個評審已完成。AbandonedAbandoned 是一個垃圾評審。正在創(chuàng)建的評審必須被放棄才能被刪除（已創(chuàng)建的評審在任何狀態(tài)都可被刪除）。四、 評審過程Creating a Review （創(chuàng)建評審）Adding Reviewers （添加評審）Issuing a Review （開始評審）Performing the Review （進行評審，回復評審，完成評審）Summarising and Closing the Review （總結關閉評審）Deleting an Abandoned Re

9、view （刪除或取消一個評審）Moving a Review to Another Project（移動一個評審到另一個項目中）1. 創(chuàng)建評審在Crucible中創(chuàng)建評審打開Reviews Tab，選擇屏幕右上角的Tools菜單，然后再選擇Create Review.截圖: 創(chuàng)建一個評審(創(chuàng)建評審的第一步：下圖是從FishEYE中創(chuàng)建評審，從Crucible中創(chuàng)建評審請參照上文所示操作步驟。)截圖: 選擇一個項目（創(chuàng)建評審的第二步：選擇需要評審的項目）截圖: Crucible管理文件對話框（創(chuàng)建評審的第三步：選擇需要評審的文件或內容） 截圖: 在Crucible中創(chuàng)建評審（創(chuàng)建評審的第四步：

10、如需要跟Jira中Issues關聯(lián)，請在Statement of objectives中寫上Issues的關鍵字）補充說明：在JIRA中創(chuàng)建評審截圖:從JIRA中創(chuàng)建評審2. 添加評審打開Reviews界面，選擇新建的評審，單擊右上角的Start Review，開始添加評審。截圖: Crucible中新建的評審，該評審的為Draft狀態(tài)（點擊Start Review后，為Under Review狀態(tài)）評審員可以隨時刪除，刪除評審員的操作如下：以評審的創(chuàng)建者或裁判員的身份登陸Crucible. 打開需要更改評審員的評審. 單擊'Edit Review' 按鈕:找到要刪除的評審員，

11、在旁邊的復選框中去掉選擇:單擊 'Save'按鈕，保存更改. 這個評審員就會從該評審中刪除掉，并以郵件的形式通知他. 評審員只能由創(chuàng)建者或裁判員刪除.你不能從評審中刪除創(chuàng)建者和裁判員.3. 開始評審開始評審：Crucible中被稱為開始評審，它意味著評審可以正式開始.只有裁判員才能批準評審（開始評審），作者可以推薦評審，而評審員則只能評審（這個評審的動作可以在評審未結束之前的任何時候）進行。截圖: 批準評審請注意，只有作者才能推薦評審，裁判員才能批準評審。 4. 進行評審如何查找和管理你相關的評審？瀏覽你的評審，在 'Dashboard'一欄中。 瀏覽所有的評審

12、，在 'Reviews' 一欄中。 當一個文件在評審的過程中改變時，我們就要決定哪些需要評審。Crucible沒有規(guī)定如何和怎樣評審代碼。它只是提供了一種機制，記錄意見。截圖: 代碼庫版本從 'File Outdated'菜單，可以選擇查看更新的文件的最新版本，或者對這個評審添加最新的版本:截圖: 'File Outdated' 菜單5. 回復評審在評審過程中添加評審，也可以回復其別人的評審。截圖: 查看現有評審意見增加一條新的評審意見若要添加評審意見，適用于整個評審，可以選擇左邊菜單欄中的“Review Comments”，然后單擊圖標： 若針

13、對版本/更新來添加評審，可以從左邊導航欄中選擇這個文件，然后單擊圖標：要添加一個源代碼級的意見，從左側導航欄中選擇這個文件，在源代碼視力中，單擊一行代碼。你可以單擊并拖動以選擇一行或多行。注釋將懸停在最后一行選定的源代碼后面。 要選擇多行，請按住Alt鍵?；貜鸵粭l評審, 在該評審的底部單擊 'Reply'按鈕. 只有擁有評審權限的用戶，才能添加評審.關于flagging defects. 截圖: 添加評審草稿（Draft）評審可以將你自己剛創(chuàng)建的評審作為一個草稿.當你完成評審時，系統(tǒng)會提示你 ：是否發(fā)送取消編輯你的草稿評審？. 截圖: 草稿（Draft） 評審缺陷標識

14、作為被評代碼的作者，你可以自己為某行有缺陷的而未被他人評審的代碼打上缺陷標識。截圖: 缺陷標識6. 完成評審評審員已經對這個代碼再也沒有任何評審的意見時，評審員可以將對這個評審作一個完成標識，以方便其它評審員作者裁判員參考。1) 完成評審的操作為了完成評審員自己的評審,可以單擊屏幕右上方的 'Complete' 按鈕,緊挨 'Tools' 菜單:只有評審員擁有 'Complete'權限.評審員可以設置：當完成評審時，以郵件的方式告知裁判員。當評審員完成評審后，評審員仍然可以添加評審，直到裁判員總結了評審；而裁判員總結關閉評審時，不需要所有評審員都

15、完成評審。如果評審員有未完成的評審或草稿評審，當評審員完成評審時，系統(tǒng)會提示該評審員。截圖: 草稿（Draft）評審的提示。截圖: 完成評審2) 發(fā)送評審郵件你可以將你的評審意見，以郵件形式告知他人。這樣可以讓他人更快的了解你的評審活動，或監(jiān)督你的評審活動的內容。通過電子郵件發(fā)送評審意見。在Crucible中,打開該評審. 從 'Tools' 菜單中，選擇 'Email Review'（見截圖1）. 將出現 'Recipients'頁面（見截圖2）: 'To:' 可以輸入多個電子郵件，以逗號分隔. 'Recipients:

16、 你可以輸入Crucible實例名，以將他們添加到通訊組. 你也可以簡單地選擇 'Send to Review Participants' 復選框，包括所有參與評審的評審員. 單擊'Next' 按鈕. 將出現message頁面（見截圖3）: 完成相關信息后, 單擊'Send' 按鈕. 將出現 'Status' 頁面（見截圖4）,確認郵件是否發(fā)送成功. 如果用戶沒有登陸Crucible，是不能發(fā)送郵件的,但是可以以文本形式查看評審意見.截圖 1: 'Email Review' 截圖 2: 'Reci

17、pients' 頁面截圖 3: 'Message' 頁面截圖 4: 確認郵件是否發(fā)送成功7. 總結與關閉評審裁判員可以在任何時候對評審進行總結與關閉操作。通常地, 裁判員都是等所有評審員都完成評審后，才進行總結與關閉操作.總結評審：選擇屏幕右上角的'Summarize'按鈕. 可以進入評審總結頁面. 如果沒有評審意見了，單擊'Close Review' 按鈕;否則，單擊 'Continue Without Closing'按鈕. 截圖: 'Summarize' 按鈕該圖標標識：這個評審還未完成。從上圖我們可

18、以看出：Geoff Crain 沒有完成評審，因為他旁邊還有這個綠色的圖標。而這時，裁判員總結或關閉評審，將會看到一些提示信息。 雖然有未完成評審的評審員，但裁判員仍然可以總結或關閉評審。一旦評審成為總結狀態(tài)，裁判員可以添加評論的摘要，如成果任務等。截圖: 總結評審截圖:關閉評審這個總結會發(fā)送給所有參與者，且在上方會顯示 close或Reopen按鈕.只有裁判員才可以對評審進行總結，其他參與評審者沒有這個權限。即裁判員擁有'last word'權限.處于 'Summarize' 狀態(tài)的評審，可以被關閉.處于 'Summarize' 或 '

19、Closed' 狀態(tài)的評審，可以被裁判員 re-opened. 裁判員Re-open評審之后，評審變?yōu)?'Under Review'狀態(tài), 這時就允許所有參與者對該評審進行評審.我們也可以不用Re-opened一個評審，而是創(chuàng)建一個新的評審，將新評審父評審指向這個評審.8. 刪除已取消的評審刪除的評審不能被恢復。刪除已取消（dead）的評審，操作如下:從Dashboard'頁面, 單擊左側導航欄中的'My Abandoned Reviews'. 將出現一個已取消評審的列表. 單擊你想要刪除的評審. 將顯示這個評審的詳細信息,從 'Tool

20、s'菜單中選擇 'Delete'.這個評審就被刪除掉了. 截圖:在Crucible中刪除評審9. 更改評審的項目你可以更改已創(chuàng)建評審的項目：打開評審.單擊 'Edit Review'. 在'Project'中， 選擇一個新的項目. 單擊 'Done' 按鈕. 截圖: 更改評審的項目 Dashboard 頁面簡介截圖: Crucible中的Dashboard頁面默認情況下，這個頁面顯示所有用戶相關的所有活動。這里的所有活動都與Crucible有關, 比如提出評審意見, 打開或關閉評審, 提交文件至代碼庫,或更新Ji

21、ra上的Issues。Reviews欄：根據評審的狀態(tài)，對所有與你相關的評審進行分類總結。To Review 需要進行評論的評審 Require My Approval 當你被指定為裁判員或作者時，你可以推薦該評審，這類顯示的是你所有推薦的評審. To Summarize 當你被指定為裁判員時，這類顯示你已進行總結的評審. Out For Review 當前正在進行審查的評審。Drafts 這些評審已被創(chuàng)建，但尚未由裁判員批準。需要 'Approval' 或 'Require Approval'. Open 所有打開的評審，所有參與者均可進行評審。Closed

22、所有已關閉的評審。 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

23、 Tab (顯示你收藏的所有內容.) 子項: 無. 五、 使用收藏夾1. 添加一個評審至我的收藏夾。要添加評審至我的收藏夾，將鼠標移至評審的名稱上，將出現一個如截圖所示的菜單。在該菜單的右上角選擇'Tools' 菜單.再選擇 'Add Star'. 則這個評審就被添加至我的收藏夾。截圖: 添加一個評審至我的收藏夾2. 添加一條評審意見至我的收藏夾打開該評審，在需收藏的評審意見的右下方，單擊 'Add Favourites',則該評審意見就被添加至我的收藏夾。截圖:添加一條評審意見至我的收藏夾3. 添加一個項目至我的收藏夾進入'Projec

24、ts' 欄. 單擊需收藏的項目前的灰色五角星，五角星變黃，則項目被成功地加入我的收藏夾. 截圖: 添加一個項目至我的收藏夾4. 添加一個用戶至我的收藏夾 進入“People”欄，選擇需收藏的用戶，將鼠標移至該用戶上，將出現如截圖所示浮圖，然后選擇 'Follow'. 則該用戶就被添加至我的收藏夾.截圖:添加一個用戶至我的收藏夾5. 添加某個文件或文件夾至我的收藏夾進入 'Source' 欄. 選擇需收藏的文件或文件夾，單擊灰色五角星，五角星變黃。則該文件或文件夾被添加至我的收藏夾。截圖: 添加一個文件或文件夾至我的收藏夾6. 添加一個代碼庫至我的收藏夾進入'Source' 欄. 單擊需收藏的代碼庫前的灰色五角星，五角星變黃。則該代碼庫被添加至我的收藏夾。截圖: 添加一個代碼庫至我的收藏夾7. 查看我的收藏夾從 'Dashboard'欄