利用bugzilla提交Bug寫作指南.doc

利用bugzilla提交Bug寫作指南 為什么你要讀這份指南? 簡單地說，如果你報告Bug越有效,工程師完全修復(fù)它的可能性就越大這份Bug寫作指南是針對新手在書寫有效的Bug報告方面進(jìn)行指導(dǎo)的常規(guī)指南，并非每個建議都正好適用于你的軟件項目。 如何寫一份有用的Bug報告? 有用的Bug報告是用于正確修復(fù)Bug的。因此一份有用的Bug報告通常地有兩個特征： 可復(fù)現(xiàn)： 如果工程師不能發(fā)現(xiàn)或最終證明這一Bug存在,工程師或許會將它標(biāo)記為WORKSFORME(所有要重新產(chǎn)生這個bug的企圖是無效的)或INVALID(描述的問題不是一個bug)，并且繼續(xù)進(jìn)行下一個Bug的修復(fù)工作。任何你能提供的詳盡描述將為工程師修復(fù)Bug提供幫助。 詳細(xì)精確： 如果工程師能越早隔離、定位問題，就越可能方便地修復(fù)。 讓我們舉一個例子：你正在測試一個Web閱覽器，在訪問foo.網(wǎng)站時崩潰了，因此你想寫一個Bug報告: 糟糕的Bug報告：“我的瀏覽器崩潰了。我正在訪問foo.。我的計算機使用Windows系統(tǒng)。這真是個大問題，你們應(yīng)該馬上修復(fù)它。順便說一下,你們的圖標(biāo)真惡心，如果你們保留那些丑陋的圖標(biāo)，沒有人將再使用你們的軟件。還有我的祖母的主頁看上去外觀也不正確，或者，它們?nèi)桓銇y了。祝好運?！庇杏玫腂ug報告：“每當(dāng)我訪問foo.時應(yīng)用程序就崩潰了，我使用的是在WinNT4.0(ServicePack5)系統(tǒng)上的10.28.99版本。我也曾重新引導(dǎo)進(jìn)入Linux，使用10.28.99 Linux版本，這個問題也出現(xiàn)了。我發(fā)現(xiàn)每次崩潰都發(fā)生在繪制這個頁面位于上端的Foo橫幅的時候。我分析了頁面，發(fā)現(xiàn)除非你刪除border=0屬性，否則下列圖片鏈接將導(dǎo)致應(yīng)用程序崩潰：(附圖片) 如何在Bugzilla中輸入你有用的Bug報告? 在你輸入你發(fā)現(xiàn)的Bug前，應(yīng)使用 Bugzilla查詢頁檢查是否你發(fā)現(xiàn)的是已知并被報告的Bug。（如果你發(fā)現(xiàn)的Bug同第37條已經(jīng)知道的結(jié)果相同，你報告的話，就可能騷擾工程師，從而影響工程師修復(fù)Bug的效率。） 下一步,確認(rèn)你發(fā)現(xiàn)的Bug是在最新的版本中所發(fā)生的。（工程師更傾向于對那些他們正在編寫的代碼中的嚴(yán)重問題感興趣，而不是對以前那些廢棄代碼中數(shù)以百計的Bug進(jìn)行修復(fù)。） 如果你已經(jīng)在當(dāng)前版本中發(fā)現(xiàn)了一個新的Bug，請在Bugzilla中報告：從你的Bugzilla主頁中,選擇“Enteranewbug”。 選擇你發(fā)現(xiàn)Bug的產(chǎn)品。 輸入你的電子郵件地址、密碼，然后按“Login”按鈕。（如果你遺忘或還沒有得到密碼,讓密碼正文框空白，并且按E-mailmeapassword按鈕，不久你將收到包含你的密碼的電子郵件。） 現(xiàn)在，填寫那張出現(xiàn)的表格。以下說明表格中的所有含義： 你在哪兒發(fā)現(xiàn)了Bug？ 1,產(chǎn)品：在哪一個產(chǎn)品中你發(fā)現(xiàn)了Bug？你在上一頁已選擇,enter前已經(jīng)選擇, 2,版本：在產(chǎn)品的哪一個版本中你找到了Bug？Ifapplicable.如果有的話。 3,產(chǎn)品單元：在產(chǎn)品的哪一個單元中存在Bug？Bugzilla在你輸入一個Bug時，要求你必須選擇一個產(chǎn)品單元。（如果你無法確定所列產(chǎn)品單元的意思，單擊產(chǎn)品單元鏈接，那將聯(lián)接到對每個產(chǎn)品單元的詳細(xì)描述，這會幫助你作出最好選擇。） 4,平臺：在哪一個硬件平臺上你找到了這個Bug例如Macintosh、SGI、Sun、PC如果你知道這個Bug會發(fā)生在所有硬件平臺上，請選擇“All”，否則請選擇相應(yīng)的你發(fā)現(xiàn)Bug的硬件平臺，如果列表中沒有出現(xiàn)你的硬件平臺，請選擇“Other”。 5,OS：在哪一個操作系統(tǒng)（OS）中你找到了這個Bug？例如Linux、WindowsNT、MacOS8.5如果你知道這個Bug會發(fā)生在所有OS中，請選擇“All”，否則請選擇相應(yīng)的你發(fā)現(xiàn)Bug的OS，如果列表中沒有出現(xiàn)你的OS，請選擇“Other”。 這個Bug有多重要？ 1,嚴(yán)重性：這個Bug的破壞性有多大？ 這項值默認(rèn)為“normal”。（要為一個特定的Bug界定最適當(dāng)?shù)膰?yán)重性，單擊嚴(yán)重性鏈接，你將得到每個選擇的完全解釋，從Critical到Enhancement。） 2,誰將跟蹤解決Bug？ 3,分配給：哪一個工程師將負(fù)責(zé)修復(fù)這個Bug？ 在你提交Bug報告后，Bugzilla將自動把Bug分配給默認(rèn)工程師；填寫正文框?qū)⒃试S你用手工方式把它分配給其他工程師。（要察看每個產(chǎn)品單元的默認(rèn)工程師列表,請單擊產(chǎn)品單元鏈接。） 4,Cc：還有哪些人將收到這個Bug修復(fù)更新的電子郵件?列出其他需要通過電子郵件收到這個Bug修復(fù)更新的人的完整的電子郵件地址。只要你愿意，你可以輸入足夠多的電子郵件地址，電子郵件地址之間必須用逗號分隔,不可有空格。 5,關(guān)于這個Bug你還能告訴工程師什么？ 6,URL:在什么URL中你發(fā)現(xiàn)這個Bug？ 如果你是在特殊的URL中遇到Bug，請在這里提供它（們）。如果你已經(jīng)將Bug隔離在一段特殊的HTML程序段中，也請在這里為它提供URL。 7,概述：你如何在大約60個字符之內(nèi)將這個Bug進(jìn)行描述？ 一個好的概述能很快和唯一識別一份Bug報告，否則，開發(fā)者將不能通過Bug概述進(jìn)行有意義的查詢，并且在瀏覽一份有10頁長的Bug列表時，可能忽略你的Bug報告。 關(guān)于“在ToshTecra780DVDw/3c589C上安裝PCMCIA失敗”的概述是有用的標(biāo)題，而“軟件失敗”或安裝問題將是糟糕的標(biāo)題的例子。 8,描述：還有什么你能告訴工程師關(guān)于這個Bug的？ 如果可能，在這個域中請?zhí)峁﹩栴}診斷的詳細(xì)細(xì)節(jié)。 如果適用，下列的Bug報告模板將幫助你保證不會漏掉所有相關(guān)：(翻譯是我自己加的,不準(zhǔn)確的話請見諒!) 總的描述：對概述的更為詳細(xì)的補充 Drag-selectinganypagecrashesMacbuildsinNSGetFactory Bug復(fù)現(xiàn)的步驟：是跟蹤Bug必須的最小集，包含所有的特殊安裝步驟。 1)Viewanywebpage.(Iusedthedefaultsamplepage,resource:/res/samples/test0.html)觀看所有網(wǎng)頁。(我使用了缺省樣頁資源:/res/samples/test0.html) 2)Drag-selectthepage.(Specifically,whileholdingdownthemousebutton,dragthemousepointerdownwardsfromanypointinthebrowserscontentregiontothebottomofthebrowserscontentregion.)扯拽選擇頁。 (具體地，當(dāng)持續(xù)鼠標(biāo)鍵時，扯拽鼠標(biāo)向下從任何點在瀏覽器的美滿的區(qū)域?qū)g覽器的美滿的區(qū)域的底部。) 目前的結(jié)果：應(yīng)用程序在經(jīng)過那些步驟后的結(jié)果Theapplicationcrashed.應(yīng)用被碰撞。(程序崩潰) 期望的結(jié)果：當(dāng)Bug不再出現(xiàn)時，應(yīng)用程序應(yīng)有的結(jié)果 Thewindowshouldscrolldownwards.Scrolledcontentshouldbeselected. Or,atleast,theapplicationshouldnotcrash.)窗口應(yīng)該移動向下。應(yīng)該選擇移動的內(nèi)容。(或，至少，應(yīng)用不應(yīng)該碰撞。) 時間及硬件平臺：第一次出現(xiàn)這個Bug的時間及硬件平臺。 11/2/99buildonMacOS(CheckedViewer&Apprunner)11/2/99修造在MacOS(被檢查的觀察者&Apprunner) 其它環(huán)境及硬件平臺：Bug是否出現(xiàn)在其他硬件平臺或瀏覽器上。-OursOn Seamonkey(11/2/99buildonWindowsNT4.0) -DoesntOurOn Seamonkey(11/4/99buildonRedHatLinux;featurenotsupported)Inter Explorer5.0(RTMbuildonWindowsNT4.0) NetscapeCommunicator4.5(RTMbuildonMacOS) -在Seamonkey(11/2/99修造在Seamonkey(基于windowsNT4.0)-不發(fā)生在11/4/99RedHatLinux;特點沒支持的)InterExplorer5.0(RTM修造在windowsNT4.0)NetscapeCommunicator4.5(RTM基于MacOS) 其它信息：任何其他調(diào)試信息 Win32:ifyoureceiveaDr.Watsonerror,pleasenotethetypeofthecrash,andthemodulethattheapplicationcrashedin.(e.g.aessviolationinapprunner.exe) MacOS:ifyourerunningMacsBug,pleaseprovidetheresultsofahowand ansc.Unix:pleaseprovideaminimizedstacktrace,whichcanbegeneratedbytypi