Bug Writing Guidelines

<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="referrer" content="origin"> <script type="text/javascript" src="https://bugzilla.redhat.com/page.cgi?1732759004.362634&id=bayotbase/publicfielddefs.js&hash=b3b9a7c4f04c5537a495c60af7e7c9c0"></script> <script type="text/javascript">var BB_CONFIG = ({"defaults":{"op_sys":"Unspecified","bugentry_fields":["summary","product","component","rh_sub_components","severity","priority","comment"],"priority":"Unspecified","severity":"Unspecified","platform":"Unspecified"},"user":{"logged_in":false,"tz":"UTC","tzos":0,"groups":[],"enterable_products":[],"tzsn":"UTC"}});</script><script type="text/javascript"> var classifications = '[ { "name": "Red Hat", "description": "Red Hat Products"},{ "name": "Red Hat Storage", "description": "Red Hat (IBM) Storage Products"},{ "name": "JBoss", "description": "JBoss Products"},{ "name": "CentOS", "description": "CentOS Projects"},{ "name": "Fedora", "description": "Fedora Products"},{ "name": "Community", "description": "Community Projects"},{ "name": "oVirt", "description": "oVirt Virtualization Management Projects"},{ "name": "Internal", "description": "Internal Projects."},{ "name": "Other", "description": "Other Miscellaneous Products"},{ "name": "Unclassified", "description": "Not assigned to any classification"},{ "name": "Workflows", "description": "User driven workflows"},{ "name": "Retired", "description": "Products that have reached end of life, were never released, or have moved to a different issue tracking system."} ]'; var c_optgroups = JSON.parse(classifications); </script> <title>Bug Writing Guidelines</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link href="https://bugzilla.redhat.com/skins/standard/global.css?1731976238" rel="stylesheet" type="text/css"><link href="https://bugzilla.redhat.com/extensions/BayotBase/web/css/base.css?1731976238" rel="stylesheet" type="text/css"><link href="https://bugzilla.redhat.com/extensions/BayotBase/web/jquery-ui-1.12.1.custom/jquery-ui.min.css?1731976238" rel="stylesheet" type="text/css"><link href="https://bugzilla.redhat.com/extensions/ExternalBugs/web/css/global.css?1731976238" rel="stylesheet" type="text/css"><link href="https://bugzilla.redhat.com/extensions/FontAwesome/web/css/all.min.css?1731976238" rel="stylesheet" type="text/css"><link href="https://bugzilla.redhat.com/extensions/RedHat/web/css/redhat.css?1731976238" rel="stylesheet" type="text/css"><link href="https://bugzilla.redhat.com/extensions/RedHat/web/alertify/css/alertify.min.css?1731976238" rel="stylesheet" type="text/css"><link href="https://bugzilla.redhat.com/extensions/RedHat/web/alertify/css/themes/bootstrap.min.css?1731976238" rel="stylesheet" type="text/css"><link href="https://bugzilla.redhat.com/extensions/SelectizeJS/web/css/selectize.bootstrap3.css?1731976238" rel="stylesheet" type="text/css"><link href="https://bugzilla.redhat.com/extensions/SelectizeJS/web/css/SelectizeJS.css?1731976238" rel="stylesheet" type="text/css"> <script type="text/javascript" src="https://bugzilla.redhat.com/js/yui/yahoo-dom-event/yahoo-dom-event.js?1731976238"></script><script type="text/javascript" src="https://bugzilla.redhat.com/js/yui/cookie/cookie-min.js?1731976238"></script><script type="text/javascript" src="https://bugzilla.redhat.com/extensions/BayotBase/web/js/jquery-3.6.0.min.js?1731976238"></script><script type="text/javascript" src="https://bugzilla.redhat.com/extensions/BayotBase/web/jquery-ui-1.12.1.custom/jquery-ui.min.js?1731976238"></script><script type="text/javascript" src="https://bugzilla.redhat.com/extensions/BayotBase/web/js/jquery.cookie.js?1731976238"></script><script type="text/javascript" src="https://bugzilla.redhat.com/extensions/BayotBase/web/js/jquery.jsonrpc.js?1731976238"></script><script type="text/javascript" src="https://bugzilla.redhat.com/extensions/BayotBase/web/js/Base.js?1731976238"></script><script type="text/javascript" src="https://bugzilla.redhat.com/extensions/BayotBase/web/js/bayot.util.js?1731976238"></script><script type="text/javascript" src="https://bugzilla.redhat.com/js/global.js?1731976238"></script> <script type="text/javascript">  </script> <script type="text/javascript" src="https://bugzilla.redhat.com/extensions/ExternalBugs/web/js/external_bugs.js?1731976238"></script><script type="text/javascript" src="https://bugzilla.redhat.com/extensions/RedHat/web/alertify/alertify.min.js?1731976238"></script><script type="text/javascript" src="https://bugzilla.redhat.com/extensions/RedHat/web/js/redhat.js?1731976238"></script><script type="text/javascript" src="https://bugzilla.redhat.com/extensions/RedHat/web/js/accessible-menu.js?1731976238"></script><script type="text/javascript" src="https://bugzilla.redhat.com/extensions/SelectizeJS/web/js/standalone/selectize.min.js?1731976238"></script><script type="text/javascript" src="https://bugzilla.redhat.com/extensions/SelectizeJS/web/js/selectize-plugin-a11y.js?1731976238"></script><script type="text/javascript" src="https://bugzilla.redhat.com/extensions/SelectizeJS/web/js/SelectizeJS.js?1731976238"></script> <link rel="search" type="application/opensearchdescription+xml" title="Red Hat Bugzilla" href="https://bugzilla.redhat.com//search_plugin.cgi"> <link rel="shortcut icon" href="https://bugzilla.redhat.com//extensions/RedHat/web/css/favicons/production.ico?v=0"> </head> <body class="bugzilla-redhat-com status_colours_pastel yui-skin-sam"> <div id="header" role="banner"><nav id="account_menu"> <ul> <li> <button aria-expanded="false" aria-haspopup="true" aria-controls="submenu_login_options"> <i class="fa fa-user"></i> Login </button> <ul id="submenu_login_options"><li id="mini_login_container"><ul id="saml2_container"> Log in using an SSO provider: <li id="saml2auth_login_Fedora Account System"> <a href="saml2_login.cgi?idp=Fedora%20Account%20System&target=page.cgi%3Fid%3Dbug-writing.html" ><i class="fa fa-cogs" aria-hidden="true"></i>  Fedora Account System</a> </li> <li id="saml2auth_login_Red Hat Associate"> <a href="saml2_login.cgi?idp=Red%20Hat%20Associate&target=page.cgi%3Fid%3Dbug-writing.html" ><i class="fa fa-user-secret" aria-hidden="true"></i>  Red Hat Associate</a> </li> <li id="saml2auth_login_Red Hat Customer"> <a href="saml2_login.cgi?idp=Red%20Hat%20Customer&target=page.cgi%3Fid%3Dbug-writing.html" ><i class="fa fa-user" aria-hidden="true"></i>  Red Hat Customer</a> </li> </ul> <li style="padding-left: 1em;"> Login using a Red Hat Bugzilla account <form action="page.cgi?id=bug-writing.html" method="POST" class="mini_login " id="mini_login"> <input id="Bugzilla_login" required name="Bugzilla_login" class="bz_login" type="email" placeholder="Email Address" aria-label="Account Email Address"> <input class="bz_password" name="Bugzilla_password" type="password" id="Bugzilla_password" required placeholder="Password or pin+token" aria-label="Account Password or pin+token"> <input type="hidden" name="Bugzilla_login_token" value=""> <input type="submit" name="GoAheadAndLogIn" value="Login" id="log_in"> </form> </li> </li> <li id="forgot_container"> <button aria-expanded="false" aria-haspopup="true" aria-controls="submenu_forgot_password"> <i class="fa fa-exclamation-triangle" aria-hidden="true"></i>  Forgot Password </button> <ul id="submenu_forgot_password"> <li style="padding-left: 2em;"> <form action="token.cgi" method="post" id="forgot_form" class="mini_forgot">  <input name="loginname" size="20" id="login" required type="email" placeholder="Your Email Address" aria-label="Account Email Address"> <input id="forgot_button" value="Reset Password" type="submit"> <input type="hidden" name="a" value="reqpw"> <input type="hidden" id="token" name="token" value="1732762518-KeqA_jmnNDMYKAMdQbwF5ypWogFNxYYgZLCrHpGUU-0"> </form> </li> </ul> </li> <li> <a href="createaccount.cgi"><span><i class="fas fa-plus" aria-hidden="true"></i>  Create an Account</span></a> </li> </ul> </li> </ul> </nav> <div id="titles"> <span id="title">Red Hat Bugzilla – Bug Writing Guidelines</span> </div> <nav id="site_menu" aria-label="Site Menu" role="navigation"><ul> <li><a href="./">Home</a></li> <li><a href="enter_bug.cgi">New</a></li> <li> <button aria-expanded="false" aria-haspopup="true" aria-controls="submenu_search">Search <i class="fas fa-search"></i></button> <ul id="submenu_search"> <li><a href="query.cgi?format=specific">Simple Search</a></li> <li><a href="query.cgi?format=advanced">Advanced Search</a></li> </ul> </li> <li> <button aria-expanded="false" aria-haspopup="true" aria-controls="submenu_my_links">My Links</button> <ul id="submenu_my_links"> <li><a href="describecomponents.cgi">Browse</a></li> <li> <a href="request.cgi">Requests</a> </li> <li> <button aria-expanded="false" aria-haspopup="true" aria-controls="submenu_reports">Reports</button> <ul id="submenu_reports"> </li> <li> <button aria-expanded="false" aria-haspopup="true" aria-controls="submenu_current_state">Current State</button> <ul id="submenu_current_state"> <li id="report_search"> <a href="query.cgi">Search</a> </li> <li id="report_tabular"> <a href="query.cgi?format=report-table">Tabular reports</a> </li> <li id="report_graphical"> <a href="query.cgi?format=report-graph">Graphical reports</a> </li> <li id="report_duplicates"> <a href="duplicates.cgi">Duplicates</a> </li> </ul> </li> <li> <button aria-expanded="false" aria-haspopup="true" aria-controls="submenu_other_reports">Other Reports</button> <ul id="submenu_other_reports"> <li> <a href="https://bugzilla.redhat.com/page.cgi?id=user_activity.html">User Changes</a> </li> </ul> </li> <li> <button aria-expanded="false" aria-haspopup="true" aria-controls="submenu_plotly_reports">Plotly Reports</button> <ul id="submenu_plotly_reports"> <li> <a href="https://bugzilla.redhat.com/page.cgi?id=bug_status.html">Bug Status</a> </li> <li> <a href="https://bugzilla.redhat.com/page.cgi?id=bug_severity.html">Bug Severity</a> </li> <li> <a href="https://bugzilla.redhat.com/page.cgi?id=non_defaults.html">Non-Defaults</a> </li> </ul> </li> </ul> </li><li><a href="page.cgi?id=productdashboard.html">Product Dashboard</a></li> </ul> </li> <li> <button aria-expanded="false" aria-haspopup="true" aria-controls="submenu_help">Help</button> <ul id="submenu_help"> <li><a href="page.cgi?id=bug-writing.html">Bug Writing Guidelines</a></li> <li><a href="page.cgi?id=whats-new.html">What's new</a></li> <li><a href="https://access.redhat.com/help/browsers">Browser Support Policy</a></li> <li><a href="page.cgi?id=release-notes.html">5.0.4.rh103 Release notes</a></li> <li><a href="page.cgi?id=faq.html">FAQ</a></li> <li><a href="docs/en/html/index.html">Guides index</a></li> <li><a href="docs/en/html/using/index.html">User guide</a></li> <li><a href="docs/en/html/integrating/api/Bugzilla/WebService/Bug.html">Web Services</a></li> <li><a href="page.cgi?id=redhat/contact.html" >Contact</a></li> <li><a href="page.cgi?id=terms-conditions.html" >Legal</a></li> </ul> </li> <li class="form"> <form action="buglist.cgi" method="get" onsubmit="if (this.quicksearch.value == '') { alert('Please enter one or more search terms first.'); return false; } return true;"> <input type="hidden" id="no_redirect_top" name="no_redirect" value="0"> <script type="text/javascript"> if (history && history.replaceState) { var no_redirect = document.getElementById("no_redirect_top"); no_redirect.value = 1; } </script> <input class="txt" type="text" id="quicksearch_top" name="quicksearch" aria-label="Quick Search input" title="Quick Search" value=""> <input class="btn" type="submit" value="Quick Search" aria-label="Run Quick Search" id="find_top"> </form> <a href="page.cgi?id=quicksearch.html" title="Quicksearch Help">[?]</a> </li> </ul> </nav> </div> <div id="bugzilla-body" role="main"> <noscript> <div id="no-js-message">This site requires JavaScript to be enabled to function correctly, please enable it.</div> </noscript> <p>Effective bug reports are the most likely to be fixed. These guidelines explain how to write such reports. <h3>Principles</h3> <ul> <li>Be precise</li> <li>Be clear - explain it so others can reproduce the bug</li> <li>One bug per report</li> <li>No bug is too trivial to report - small bugs may hide big bugs</li> <li>Clearly separate fact from speculation</li> </ul> <h3>Preliminaries</h3> <ol> <li>Reproduce your bug using a recent build of the software, to see whether it has already been fixed. </li> <li><a href="query.cgi?format=specific">Search</a> Red Hat Bugzilla, to see whether your bug has already been reported.</li> </ol> <h3>Reporting a New Bug</h3> <p>If you have reproduced the bug in a recent build and no-one else appears to have reported it, then:</p> <ol> <li>Choose "<a href="enter_bug.cgi">Enter a new bug</a>"</li> <li>Select the product in which you've found the bug</li> <li>Fill out the form. Here is some help understanding it:</li> </ol> <blockquote> <p><b>Component:</b> In which sub-part of the software does it exist?<br> This field is required. Click the word "Component" to see a description of each component. If none seems appropriate, look for a "General" component.</p> <p><b>OS:</b> On which operating system (OS) did you find it? (e.g. Linux, Windows XP, Mac OS X.)<br> If you know the bug happens on more than one type of operating system, choose <em>All</em>. If your OS isn't listed, choose <em>Other</em>.</p> <p><b>Summary:</b> How would you describe the bug, in approximately 60 or fewer characters?<br> A good summary should <b>quickly and uniquely identify a bug report</b>. It should explain the problem, not your suggested solution.<br> <ul> <li>Good: "<kbd>Cancelling a File Copy dialog crashes File Manager</kbd>"</li> <li>Bad: "<kbd>Software crashes</kbd>"</li> <li>Bad: "<kbd>Browser should work with my web site</kbd>"</li> </ul> <b>Description:</b> The details of your problem report, including:</p> <blockquote> <p><b>Overview:</b> More detailed restatement of summary.</p> <blockquote> <pre> Drag-selecting any page crashes Mac builds in the NSGetFactory function. </pre> </blockquote> <p><b>Version-Release number of selected component (if applicable):</b> The version number of the component that is causing this problem. For example if you were experiencing a problem with the grep command in RHEL 6, the component version would be 2.6.3.</p> <blockquote> <pre> 2.6.3 </pre> </blockquote> <p><b>How reproducible:</b> Can this bug always be reproduced, or only reproduced occasionally.</p> <blockquote> <pre> always </pre> </blockquote> <p><b>Steps to Reproduce:</b> Minimized, easy-to-follow steps that will trigger the bug. Include any special setup steps.</p> <blockquote> <pre> 1) View any web page. (I used the default sample page, resource:/res/samples/test0.html) 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.) </pre> </blockquote> <p><b>Actual Results:</b> What the application did after performing the above steps.</p> <blockquote> <pre> The application crashed. </pre> </blockquote> <p><b>Expected Results:</b> What the application should have done, were the bug not present.</p> <blockquote> <pre> The window should scroll downwards. Scrolled content should be selected. (Or, at least, the application should not crash.) </pre> </blockquote> <p><b>Build Date & Hardware:</b> Date and hardware of the build in which you first encountered the bug.</p> <blockquote> <pre> Build 2006-08-10 on Mac OS 10.4.3 </pre> </blockquote> <p><b>Additional Builds and Platforms:</b> Whether or not the bug takes place on other platforms (or browsers, if applicable).</p> <blockquote> <pre> Doesn't Occur On Build 2006-08-10 on Windows XP Home (Service Pack 2) </pre> </blockquote> <p><b>Additional Information:</b> Any other useful information. <br><br>For crashing bugs:</p> <ul> <li><b>Windows:</b> Note the type of the crash, and the module that the application crashed in (e.g. access violation in apprunner.exe).</li> <li><b>Mac OS X:</b> Attach the "Crash Reporter" log that appears upon crash. Only include the section directly below the crashing thread, usually titled "Thread 0 Crashed". Please do not paste the entire log!</li> </ul> </blockquote> <p>Double-check your report for errors and omissions, then press "Commit". Your bug report will now be in the Red Hat Bugzilla database.<br> </p> </blockquote> </div> <footer id="footer"> <div class="intro"></div> <ul id="useful-links"> <li id="links-actions"><ul> </ul> </li> </ul> <div class="outro"><a href="page.cgi?id=redhat/privacy.html">Privacy</a> <a href="page.cgi?id=redhat/contact.html">Contact</a> <a href="page.cgi?id=faq.html">FAQ</a> <a href="page.cgi?id=terms-conditions.html">Legal</a></div> </footer> <script type="text/javascript"> $(document).ready(function() { $('form').submit(function( event ) { dt_submit(); }); $('#site_menu').accessibleMenu(); $('#account_menu').accessibleMenu(); $('#site_menu').addClass('loaded'); $('#account_menu').addClass('loaded'); }); if (window.self !== window.top) { $('#header').addClass('bz_default_hidden'); $('#footer').addClass('bz_default_hidden'); $('.navigation').addClass('bz_default_hidden'); $('body').css('background-image', 'none'); } </script><script type="text/javascript"> $(document).ready(function() { selectize_standard_selects(); }); </script> </body> </html>

CINXE.COM

Bug Writing Guidelines