Changes between Version 2 and Version 3 of WorkingConventions


Ignore:
Timestamp:
Oct 25, 2006 8:40:44 AM (7 years ago)
Author:
simonmar
Comment:

guidelines about pushing

Legend:

Unmodified
Added
Removed
Modified
  • WorkingConventions

    v2 v3  
    1212== Committing changes == 
    1313 
    14 If you have commit permission (pretty easy to get, just demonstrate your competence by sending us a patch or two first), then you can use {{{darcs push}}} to commit changes directly to the main repository. 
     14If you have permission to push patches directly to the repository (pretty easy to get, just demonstrate your competence by sending us a patch or two first), then you can use {{{darcs push}}}: 
    1515 
    1616{{{ 
     
    2222Do not forget to {{{darcs record}}} your changes first! 
    2323 
    24 Please test changes before committing: you can run a cut-down version of the full test suite like this: 
     24=== When to record/push === 
    2525 
    26 {{{ 
    27   $ cd testsuite/tests/ghc-regress 
    28   $ make fast 
    29 }}} 
     26Guidelines for pushing patches to GHC: 
    3027 
    31 You need to have {{{testsuite}}} checked out, of course.  Running {{{make fast}}} should only take a few minutes. 
     28 * Try to make small patches (i.e. work in consistent increments). 
    3229 
     30 * If possible, push often.  This helps to avoid conflicts. 
     31 
     32 * Rather than push conflicting patches followed by conflict resolutions, use 
     33   amend-record to make a single patch.  Darcs currently doesn't handle conflicts 
     34   well, so we are trying to keep the HEAD clean of conflicts for now.  It doesn't 
     35   matter so much on the stable branches though. 
     36 
     37 * Try not to break anything.  At the minimum, the tree should build on your system with 
     38   the patch, better still [wiki:Building/RunningTests test your changes] before 
     39   pushing.  The nightly builds will show up any breakage on other platforms. 
     40   [[br]][[br]] 
     41   If you do end up breaking the build then it's not the end of the world, 
     42   so don't sweat about it too much. History shows that even people 
     43   called Simon are not immune from doing so! 
     44 
     45 * Discuss anything you think might be controversial before pushing it. 
     46 
     47