diff options
Diffstat (limited to 'files/zh-tw/mozilla/qa/bug_writing_guidelines/index.html')
| -rw-r--r-- | files/zh-tw/mozilla/qa/bug_writing_guidelines/index.html | 246 |
1 files changed, 0 insertions, 246 deletions
diff --git a/files/zh-tw/mozilla/qa/bug_writing_guidelines/index.html b/files/zh-tw/mozilla/qa/bug_writing_guidelines/index.html deleted file mode 100644 index 57d1cc41db..0000000000 --- a/files/zh-tw/mozilla/qa/bug_writing_guidelines/index.html +++ /dev/null @@ -1,246 +0,0 @@ ---- -title: Bug writing guidelines -slug: Mozilla/QA/Bug_writing_guidelines -tags: - - 錯誤回報 -translation_of: Mozilla/QA/Bug_writing_guidelines ---- -<div class="note"> -<p><strong>If you need help with Mozilla software (for example with Firefox, Seamonkey or Thunderbird), use one of the available <a href="http://www.mozilla.org/support/">support options</a>.</strong> Do not edit this page!</p> -</div> - -<p><span class="seoSummary">This page assumes you'd like to contribute to the Mozilla project by collecting enough information to enter a useful bug report in Bugzilla, the Mozilla bug tracking system.</span> Thank you!</p> - -<p>If you're new to reporting bugs, you may want to try getting help from the more experienced contributors. See the Community section on the <a href="/en-US/docs/QA">QA</a> page for pointers. If you're going to report a Firefox bug, you can also get assistance in the <span style="font-family: monospace;">#firefox</span> channel on <a href="irc://irc.mozilla.org/firefox">irc.mozilla.org</a>. For other projects (e.g., Thunderbird, SeaMonkey) you can find the appropriate channel on <a href="https://wiki.mozilla.org/IRC">IRC</a>.</p> - -<h2 id="如何回報錯誤">如何回報錯誤</h2> - -<h3 id="每次回報一個錯誤">每次回報一個錯誤</h3> - -<p>如此一來能夠有效率地處理每個錯誤。</p> - -<h3 id="其他需要您注意的事項">其他需要您注意的事項</h3> - -<ol> - <li>釐清如何 <strong>重現您遇到的錯誤</strong>： - - <ul> - <li>如果能夠 <a href="#Writing_precise_steps_to_reproduce">完整描述重現錯誤過程</a> —太棒了！ — 您將提供有收穫的錯誤回報。</li> - <li>有時能夠重現問題，但不確定是用什麼特定的方法，則您需要提供有幫助的<a href="#specific-types">額外資訊。</a></li> - <li>如果無法重現問題，回報該問題可能沒有太大的幫助，除非在發現錯誤時，您有獨特的發現。</li> - </ul> - </li> - <li>檢查軟體是否已更新至最新版本。建議先測試開發中版本來確認錯誤是不是早就修正（例如：<a href="http://www.mozilla.com/en-US/firefox/channel/">Firefox Beta， Aurora</a>， 或是走在科技前端的 <a class="link-https" href="https://nightly.mozilla.org/">Nightly</a>）</li> - <li>When reporting a Firefox bug, first check if you can reproduce the bug in a <a href="https://support.mozilla.org/en-US/kb/profile-manager-create-and-remove-firefox-profiles">new Firefox profile</a>. If the bug only happens in your existing profile, try to figure out what <a href="https://support.mozilla.org/en-US/kb/troubleshoot-extensions-themes-to-fix-problems">settings, extensions</a>, or <a href="https://support.mozilla.org/en-US/kb/profiles-where-firefox-stores-user-data">files in your profile</a> are needed to reproduce the bug. - <ul> - <li>If the bug seems egregious (i.e. obviously affecting a large portion of users), there's probably something unusual about your setup that's a necessary part of the steps to reproduce the bug. You have much better chances of figuring it out than a developer who does not have access to your system.</li> - <li>If the bug falls into one of <a href="#specific-types">specific types of bugs listed in a section below</a>, it may still be useful even if you can't reproduce it in a new Firefox profile.</li> - </ul> - </li> - <li>Open the <a class="link-https" href="https://bugzilla.mozilla.org/enter_bug.cgi?format=guided">Enter a new bug</a> form, which will guide you through most of the bug reporting process: - <ul> - <li>Create a Bugzilla account if you don't have one already, select the product having the bug.</li> - <li>Enter a <strong>clear unique summary</strong> as <a href="#Writing_a_clear_summary">described below</a>; check if the bug has already been reported (if you want to be more thorough, there's an advanced guide on <a href="/en-US/docs/Screening_duplicate_bugs">screening duplicate bugs</a>).</li> - <li>Provide <strong>precise steps to reproduce</strong>, <strong>expected results</strong> and <strong>actual results</strong> as <a href="#Writing_precise_steps_to_reproduce">described in the following section</a>.</li> - <li>Provide additional information (also <a href="#Providing_additional_information">described below</a>), especially if you can't reproduce the bug in a new profile; and/or by reporting a <strong>crash</strong>, <strong>memory usage</strong>, <strong>performance</strong>, <strong>regression</strong> bug; or if the problem is with a specific web site.</li> - </ul> - </li> - <li>如果遇到多個錯誤時，請分開一個一個回報。</li> -</ol> - -<h2 id="簡短明確描述問題">簡短明確描述問題</h2> - -<p>您會怎麼用大概十幾個字描述問題？ 開發者會先看到這一部分文字。</p> - -<p>好的錯誤回報會快速且清楚說明錯誤。這是用來解釋問題的來龍去脈，請不要給予針對問題的建議。</p> - -<ul> - <li>好: "在複製檔案時按取消會讓檔案管理員當掉"</li> - <li>不夠好: "當掉了"</li> -</ul> - -<ul> - <li>好: "Down-arrow scrolling doesn't work in <textarea> styled with overflow:hidden"</li> - <li>不夠好: "瀏覽器應該要可以正常顯示我的網站"</li> -</ul> - -<h2 id="描述可以重現問題的詳細的步驟">描述可以重現問題的詳細的步驟</h2> - -<p>How can a developer reproduce the bug on his or her own computer?</p> - -<p>Steps to reproduce are the <strong>most important part of any bug report</strong>. If a developer is able to reproduce the bug, the bug is very likely to be fixed. If the steps are unclear, it might not even be possible to know whether the bug has been fixed.</p> - -<table class="standard-table"> - <tbody> - <tr> - <th>在問題回報裡應該寫些什麼 ?</th> - <th>好的例子（描述細節）</th> - <th> - <p>不好的例子（敘述籠統）</p> - </th> - </tr> - <tr> - <td> - <p>說說你能不能控制卡 bug 的時機。</p> - - <p>可以故意卡、偶爾遇到、不能控制。</p> - </td> - <td>照著下面的步驟做問題就出現了:</td> - <td> </td> - </tr> - <tr> - <td> - <p>描述如何命令 Firefox 做你想做的事。</p> - </td> - <td> - <p>1. 點桌面捷徑打開 Firefox<br> - 2. 按下 Cmd+N （Windows 系統按 Ctrl+N ）來打開新的視窗。</p> - - <p>3. 把 <a class="link-https" href="https://mail.google.com/" rel="freelink">https://mail.google.com/</a> 複製貼上到網址列然後按Enter。</p> - </td> - <td>在新視窗打開Gmail</td> - </tr> - <tr> - <td> - <p>照著步驟做後，清楚地描述<strong>你看到的 (實際) 結果</strong> 和 <strong>預期結果。</strong> 請將這兩項分開來寫。</p> - </td> - <td><strong>預期結果</strong>: 我的收件匣正常顯示。<br> - <strong>實際結果</strong>: 我的收件匣顯示 '您的瀏覽器不支援 Cookies (錯誤 -91)'。</td> - <td> - <p> </p> - - <p>"網頁跑不出來"</p> - </td> - </tr> - </tbody> -</table> - -<h2 id="提供額外的資訊">提供額外的資訊</h2> - -<p>The following information is requested for most bug reports. You can save time by providing this information below the Expected results. If you need to attach multiple files, you can do so after submitting the report.</p> - -<h3 id="For_specific_types_of_bugs"><a name="specific-types">For specific types of bugs</a></h3> - -<p>If you are reporting a <strong>crash bug</strong>, please <a href="/en-US/docs/How_to_get_a_stacktrace_for_a_bug_report">include a Breakpad ID or attach stack trace</a>, and include the crash signature in the bug summary as well as in the <strong>Crash Signature</strong> field.</p> - -<p>If you are reporting a <strong>memory use or leak bug</strong>, please <a href="/en-US/docs/Mozilla/Performance/about:memory">attach the output of about:memory</a>. Ideally, find steps to reproduce an increase in what is shown in about:memory (even after clicking the "Minimize memory usage" button at the bottom). If you have trouble finding steps to reproduce, try the Firefox Support page titled <a href="https://support.mozilla.org/en-US/kb/firefox-uses-too-much-memory-ram">Firefox Uses Too Much Memory (Ram) - How to Fix</a>. If you are a C++ developer, <a class="link-https" href="https://developer.mozilla.org/en-US/docs/Mozilla/Performance">more precise tools are available</a>.</p> - -<p>If you are reporting a <strong>bug about slowness or high CPU usage</strong>, please <a href="/en-US/docs/Mozilla/Performance/Reporting_a_Performance_Problem">provide a link to the performance profile in the bug</a>.</p> - -<p>If you are reporting a <strong>hang</strong> (beachball on OS X or "not responding" on Windows), please follow the instructions in <a href="/en-US/docs/How_to_Report_a_Hung_Firefox">How to Report a Hung Firefox</a>.</p> - -<p>If you are reporting a bug involving a <strong>Flash hang</strong>, please visit <a href="https://wiki.mozilla.org/Flash/Hang_Debugging">https://wiki.mozilla.org/Flash/Hang_Debugging</a> to learn how to provide useful information for developers.</p> - -<p>If you are reporting a <strong>bug involving a specific web page</strong>, please try to make a <a href="/en-US/docs/Reducing_testcases">reduced testcase</a> and attach it to the bug report. If you don't have time or expertise, please report the issue to <a href="https://webcompat.com/">webcompat.com</a> instead, where our volunteers will do this for you.</p> - -<p>If the bug was <strong>recently introduced</strong>, finding a <a href="http://mozilla.github.io/mozregression/quickstart.html">regression window</a> can help identify the cause of the bug.</p> - -<p><a href="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html#intermittent">What if my bug seems "random" or "intermittent"?</a></p> - -<h3 id="For_most_Firefox_bugs">For most Firefox bugs</h3> - -<p>You should provide the following information for most Firefox bugs.</p> - -<table class="standard-table"> - <tbody> - <tr> - <th>What should you include in a bug report?</th> - <th>Example</th> - </tr> - <tr> - <td>Indicate if the problem can be reproduced using a <a href="https://support.mozilla.org/en-US/kb/profile-manager-create-and-remove-firefox-profiles">new Firefox profile</a> and any changes you need to make in order to reproduce.</td> - <td>The problem can be reproduced in a new profile, but only if Preferences -> Privacy & Security -> Tracking Protection is selected.</td> - </tr> - <tr> - <td>If you can only reproduce with an existing profile try to figure out what <a href="https://support.mozilla.org/en-US/kb/troubleshoot-extensions-themes-to-fix-problems">settings, extensions</a>, or <a href="https://support.mozilla.org/en-US/kb/profiles-where-firefox-stores-user-data">files in your profile</a> are needed to reproduce the bug. If you skip the step, <a href="https://support.mozilla.org/en-US/kb/use-troubleshooting-information-page-fix-firefox">save the troubleshooting information from about:support</a> to a file and attach it to the bug report.</td> - <td>I can't reproduce in a new profile, about:support information from the offending profile is attached.</td> - </tr> - <tr> - <td> - <p>Indicate if the problem can be reproduced using the <a href="https://nightly.mozilla.org/">latest Nightly build</a>. Include the <strong>Build ID</strong> from <a href="https://support.mozilla.org/en-US/kb/use-troubleshooting-information-page-fix-firefox">about:support</a>.</p> - - <p>If possible, test using the new Firefox profile you created. If you need to test the Nightly build with your regular profile, you might want to <a href="https://support.mozilla.org/en-US/kb/back-and-restore-information-firefox-profiles">back up the profile</a> first, since the pre-release build may corrupt your data.</p> - </td> - <td>The problem can be reproduced on the latest Nightly (Build ID 20170416100136).</td> - </tr> - </tbody> -</table> - -<p> </p> - -<div class="originaldocinfo"> -<h2 id="Original_document_information">Original document information</h2> - -<ul> - <li>Author(s): Jesse Ruderman, Gervase Markham</li> - <li>Other Contributors: Eli Goldberg, Claudius Gayle, Jan Leger, Felix Miata, Peter Mock, Chris Pratt, Chris Yeh, and others.</li> -</ul> -</div> - -<p> </p> - -<hr> -<h2 id="Advanced">Advanced</h2> - -<h3 id="Finding_the_correct_product_and_component" name="Finding_the_correct_product_and_component"><strong style="font-weight: bold;">Finding the correct product and component</strong></h3> - -<p>You will be asked to categorize your bug into a "product" and a "component" within that product, in order to direct your report to the correct developers.</p> - -<p>If you're using Firefox, the bug is most likely in "Firefox", "Toolkit", or "Core".</p> - -<ul> - <li><a class="link-https" href="https://bugzilla.mozilla.org/describecomponents.cgi?product=Firefox">List of components in the "Firefox" product</a> - Most parts of Firefox that you interact with directly</li> - <li><a class="link-https" href="https://bugzilla.mozilla.org/describecomponents.cgi?product=Toolkit">List of components in the "Toolkit" product</a> - Interface widgets and some frontend features</li> - <li><a class="link-https" href="https://bugzilla.mozilla.org/describecomponents.cgi?product=Core">List of components in the "Core" product</a> - Web page rendering, networking, etc.</li> -</ul> - -<p>When in doubt, search for similar bugs and see which component they are in.</p> - -<p>If none of the components seem appropriate, look for a "General" component in the most appropriate product.</p> - -<h3 id="General_Outline_of_a_Bug_Report">General Outline of a Bug Report</h3> - -<div class="note"> -<p>Most of the following article has been merged into this page from QMO: How to write a proper bug</p> -</div> - -<ul> - <li><strong>Summary</strong>: How would you describe the bug in less than 60 characters? It should quickly and uniquely identify a bug report as well as explain the problem, not your suggested solution. Good: "Canceling a File Copy dialog crashes File Manager" Bad: "Software crashes" Bad: "Browser should work with my web site"</li> - <li><strong>Component</strong>: In which sub-part of the software does it exist? This field is a requirement to submit any bug report. Click the word "Component" to see a description of each component. If none seems appropriate, highlight the "General" component.</li> - <li><a name="version"> </a><strong>Version</strong>: select the earliest Version with what the problem can be reproduced: - <ul> - <li>Developers will use that information to narrow down the commit what introduced a regression</li> - <li>QA staff needs that information to distinguish bugs with similar symptoms, but different roots. - <ul> - <li>Bugs that definitively appeared in different <em>Product</em> <em>Versions</em> probably will have different roots</li> - <li>But Bugs that started with the same <em>Product</em> <em>Version</em> probably are DUPLICATEs</li> - </ul> - </li> - <li><em>Trunk</em> does not allow any useful query. We have <em>Trunk</em> version bugs from beginning of the project until today, no common characteristics at all what can be tagged with this version. Avoid Trunk, replace it by precise information with what version the problem appeared if you can.</li> - </ul> - </li> - <li><strong>OS</strong>: On which operating system (OS) did you find it? (E.g. Linux, Windows, and Mac.) Example: "<em>If you know the bug happens on more than one type of operating system, choose "All". If your OS isn't listed, choose Other".</em></li> - <li><strong>Description</strong>: The details of your problem report, including: - <ul> - <li><u>Overview</u>: This is a larger detailed restatement of the summary. An example would be: <em>"Drag-selecting any page crashes Mac builds in the NSGetFactory function"</em>.</li> - <li><u>Build Id</u>: To find this either go to the "about:support" page via the location bar or, if you have MozQA's <a href="https://addons.mozilla.org/en-US/firefox/addon/nightly-tester-tools/">Nightly Tester Tools</a> extension, then go to Tools | Nightly Tester Tools and select the option that contains the output of the build Id. It should look something like this: <em>"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:38.0) Gecko/20100101 Firefox/38.0 ID:20150330004006 CSet: 9e57e9776571"</em>.</li> - <li><u>Additional Builds and Platforms</u>: Whether or not the bug takes place on other platforms (or browsers, if applicable). It should look something like this: <em>"Doesn't Occur On Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10; rv:38.0) Gecko/20100101 Firefox/38.0 ID:20150330004006 CSet: 9e57e9776571"</em>.</li> - </ul> - </li> - <li><strong>Steps to Reproduce</strong>: Minimized, easy-to-follow steps that will trigger the bug. If they're necessary, make sure to include any special setup steps. A good example of this would look like the following:<br> - 1) View any web page. (I used the default sample page, http://www.google.com/).<br> - 2) Drag-select the page. Specifically, while holding down the mouse button, drag the mouse pointer downwards from any point in the browser's content region to the bottom of the browser's content region.</li> - <li><strong>Actual Results</strong>: What the application did after performing the above steps. An example would be: <em>The application crashed.</em></li> - <li><strong>Expected Results</strong>: What the application should have done, were the bug not present. An example would be: <em>The window should scroll downwards. Scrolled content should be selected. Or, at least, the application should not crash.</em></li> -</ul> - -<p> </p> - -<div class="originaldocinfo"> -<h4 id="Original_document_information_2">Original document information</h4> - -<ul> - <li>Author(s): Aakash Desai</li> - <li>Date last modified: June 3, 2013 at 2:41 am PST</li> -</ul> -</div> |