Changes between Version 2 and Version 3 of Developer/Bug_Reporting


Ignore:
Timestamp:
01/16/12 22:05:48 (11 years ago)
Author:
Gedare
Comment:

Move some of the Bug Reporting procedures to here.

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Bug_Reporting

    v2 v3  
    88Our preferred way of receiving patches is via the [http://www.rtems.com/bugzilla RTEMS Bugzilla] bug reporting system. A secondary method for posting patches is through the [wiki:TBR/Website/RTEMSMailingLists Developer's Mailing List].
    99
    10 TODO: add instructions and link to this page.
     10TODO: add instructions for submitting bugs through the bugzilla interface. Redirect external links to the bugzilla to this page.
     11
     12= Managing Bugs (Bugzilla and the test-suite) =
     13
     14
     15This section contains information mostly intended for RTEMS contributors.  But if you submit a bug report, it is very important for you to submit a reproducible test case.  These submitted test cases end up being added to the test suite to prevent future regressions.
     16
     17If you find a bug, but you are not fixing it (yet):
     18
     19# Create a (minimal) test-case.
     20# Add the test-case to our test-suite, documenting it as a current failure unless the bug is a regression.
     21# Add a bug report referencing the test-case to Bugzila.
     22
     23If you want to provide additional information in the bug tracking system about a reported bug:
     24
     25# If the bug has been tracked down to a specific area or routine in RTEMS, please provide information about its location.
     26# Minimize the test case.
     27# Try the test case with earlier and later versions of RTEMS to determine which versions it affects and whether it is a regression. If it is a regression, identify the patch that introduced it.
     28
     29If you fix a bug for which there is already a Bugzila entry:
     30
     31# Remove the failure notation on the test-case.
     32# Attach your fix and test case to the Bugzilla bug report.
     33# Close the bug report in Bugzila.
     34
     35If you find a bug, and you are fixing it right then:
     36
     37# Create a (minimal) test-case.
     38# Add the test-case to our test-suite, documenting it as known to work.
     39# Check in your fixes.
     40= Maintainer's View of Fields =
     41
     42
     43As a RTEMS-specific convention, we will attach a special meaning to some fields. The State field should be used in the following way:
     44
     45 *  open - The PR has been filed and the responsible person(s) notified.
     46 *  analyzed - A maintainer has verified that this is indeed a bug in RTEMS. Every once in a while, old reports will need to be rechecked, to find out whether the bug still exists. At that time, an indication should be left in the report who tested the bug and when.
     47 *  feedback - The submitter was asked for further information, or asked to try out a patch. The PR remains in that state until the submitter responds.
     48 *  working - Someone is actively working on fixing the problem and has determined that it may take a while to fix. The intention of this state is to make sure that if someone is working on the problem, that everyone knows it so they can better coordinate efforts.
     49 *  suspended - Work on the problem has been postponed. This happens if a timely solution is not possible or is not cost-effective at the present time. The PR continues to exist, though a solution is not being actively sought. If the problem cannot be solved at all, it should be closed rather than suspended.
     50
     51In addition, the high priority is reserved to maintainers in RTEMS, indicating that a certain problem must be solved before the next version of RTEMS is released.
     52= Procedures and Policies =
     53
     54
     55Bugs that are in state "feedback" because they lack information that is necessary for reproducing the problem can be closed if no response was received for three months.
     56
     57Regressions should be explicitly marked as such. The synopsis line should read
     58
     59{{{
     60    [<branches-to-fix> regression] <rest-of-synopsis>
     61}}}
     62
     63where <branches-to-fix> is the list of maintained branches (separated by slashes) that need fixing. A regression should start with priority "high" to bring it to attention. It may be downgraded later if a defect is not important enough to justify "high priority".
     64
     65Bugs that refer to older releases or snapshots/CVS versions should be put into state "feedback", asking the reporter whether they can still reproduce the problem and to report their findings in any case (whether positive or negative).
     66
     67 *  If the response is "works now", close the report,
     68 *  if the response is "still broken", change the state to "open", and
     69 *  if no response arrives, close the PR after three months.