Changes between Version 5 and Version 6 of WorkingConventions/FixingBugs


Ignore:
Timestamp:
Oct 8, 2007 11:22:26 AM (7 years ago)
Author:
simonpj
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WorkingConventions/FixingBugs

    v5 v6  
    11= How to contribute a bug fix to GHC = 
    22 
    3 Please help us fix bugs in GHC!  GHC is so large, and is used in such diverse ways by so many people, that we really need your help in fixing bugs, especially those that show up in specialised situations. 
     3Please help us fix bugs in GHC!  GHC is so large, and is used in such diverse ways by so many people, that we really need your help in fixing bugs, especially those that show up in specialised situations.   
    44 
    5 Here's how to go about it. 
     5There are two ways to help: the Quick Fix and the True Way. 
     6 
     7== The Quick Fix == 
     8 
     9Some bugs are easy to fix: improvement in documentation, misleading comments, poorly-worded error messages, or egregious little bugs.  In these cases, please just 
     10 * Fix the code 
     11 * Create a patch 
     12 * Mail it to cvs-ghc@haskell.org.  Make sure you include in your email a summary of what the problem is, and the nature of your fix. 
     13 
     14This route is easy for you, but more work for us; we have to check your fix, make sure it doesn't break anything etc.  But it's a low-overhead route for easy fixes. 
     15 
     16== The True Way == 
     17 
     18Many bugs require a bit more work.  Here's how to go about helping with a non-trivial bug. 
    619 
    720 0. '''Make sure the bug is in Trac'''.  Usually it is (that's why you are working on it), but if it's a bug you have found yourself, add it to Trac before you start work.  [[BR]][[BR]] 
     
    1124   * Put a reference to the Trac bug e.g. "Trac #1466" in a comment in the test case.[[BR]][[BR]] 
    1225 0. '''Fix the bug'''! 
     26   * If your proposed fix has non-local consequences, please consult us (on cvs-ghc@haskell.org) before investing too much of your time. 
    1327   * Please follow our [wiki:WorkingConventions#Coding coding conventions] 
    1428   * Comment your fix in the source code, and include a reference to the bug ticket number, e.g. "`#1466`" (this helps when grepping for the fix later).  It is often helpful to give a small example code fragment that demonstrates the need for your fix.  This isn't always relevant; sometimes you are fixing a plain error, but often it's more subtle than that.[[BR]][[BR]]