Changes between Version 10 and Version 11 of WorkingConventions

Nov 13, 2006 4:12:05 PM (11 years ago)

minor additions


  • WorkingConventions

    v10 v11  
    2121Bug fixes always extremely welcome.  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.
    23  * In the darcs commit message, please say which Trac bug is being fixed
     23 * In the darcs commit message, please say which Trac bug is being fixed, if any
    2525 * Comment your fix in the source code.  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.
    4646   * A patch to the user manual that documents it (part of the main source-code patch)
    4747   * A (separate) patch to the testsuite repository that gives a reasonable collection of tests for the new feature.  This has to be a separate patch, because the testsuite is a separate repository.
     49 * New features should work in a way that is consistent, as far as possible, with the way that other
     50   existing GHC features work.  Adopting a variety of different styles leads to a
     51   system that is hard to learn, and complaints of the form "why doesn't it work like X?
     52   I'm familiar with X!".
    4954 * Remember that GHC HQ is not heavily staffed!  It may take us a while to give your patch the attention it deserves.