Changes between Version 49 and Version 50 of WorkingConventions


Ignore:
Timestamp:
Apr 28, 2010 4:43:15 PM (4 years ago)
Author:
simonpj
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WorkingConventions

    v49 v50  
    3232== The Bug Tracker == 
    3333 
    34 We organise our work (both bug fixing and feature requests) using the Trac bug tracker.   There are links to the bug tracker in the sidebar under "View tickets" and "Create ticket".  
     34We organise our work (both bug fixing and feature requests) using the Trac bug tracker.   There are links to the bug tracker in the sidebar under "View tickets" and "Create ticket". See also: 
     35 * [wiki:ReportABug the bug reporting guidelines] 
     36 * [wiki:WorkingConventions/FixingBugs How to fix a bug in GHC] 
    3537 
    36 The following are GHC-specific policies regarding the fields of the Trac bug tracking system. (See also [wiki:ReportABug the bug reporting guidelines].) 
     38 
     39=== Type and status === 
     40 
     41Every ticket has a '''status''' and a '''type''', which appear in the title of the ticket.  Thus "Ticket #2762 (new bug)" means status=new, and type=bug.  Here's what they mean: 
     42 
     43 * '''Type''' is one of `bug`, `feature request`, `task`, or `proposal`. We don't use `proposal` much. 
     44 * '''Status''' says what state the ticket is in.  It is one of these: 
     45   * '''New''' means what it says. 
     46   * '''Infoneeded''' means that the ticket is stalled awaiting information from the submitter (or anyone else). 
     47   * '''Closed''' means what it says. 
     48   * '''Merge''' means that a fix has been committed to the HEAD, but should be propagated to the current release branch. 
     49   * '''Patch''' means that the ticket includes a patch for review.  We love patches!  So we try hard to review patches promptly and either commit them, or start a conversation with the author. 
     50The intention is that tickets do not live in the Merge or Patch state for long. 
     51 
     52=== Other Trac ticket fields === 
     53 
     54Each ticket has a bunch of other fields too: 
    3755 
    3856 * '''Milestone''': this field is for the GHC development team to indicate by when we intend to fix the bug.  We have a milestone for each planned release (e.g. "6.12.3"), and three special milestones: 
     
    5371   closed should have an appropriate test case added to the test suite. 
    5472 
     73 * '''cc''': we pay more attention to tickets with a long cc list, so add yourself to the cc list if you care about the ticket.  Better still, add a comment to explain why you care. 
     74 
     75=== Releases === 
    5576When a release is made, any open tickets on that release's milestone will be moved to the next release's milestone. However, if they are more than 1 major release old (e.g. opened on the 6.10 branch, and about to be moved to the 6.14.1 milestone), and there is not a reason to keep them in the release milestone (e.g. a patch attached for review, or significant support in the CC field), then they will be moved to the `_|_` milestone instead. 
    5677 
     78=== Workflow === 
    5779The ticket workflow is illustrated in the following image. Most tickets will start in state "new" and, once fixed, possibly go via state "merge" if they are suitable for merging to the stable branch, before moving to state "closed". They may also go via state "infoneeded" if more information is needed from the submitter, or "patch" if a patch that needs review has been attached to the ticket. 
    5880