Changes between Version 25 and Version 26 of WorkingConventions


Ignore:
Timestamp:
Sep 7, 2007 11:09:06 AM (8 years ago)
Author:
simonmar
Comment:

point to WorkingConventions/Darcs

Legend:

Unmodified
Added
Removed
Modified
  • WorkingConventions

    v25 v26  
    1212 
    1313Important! See TestingPatches. 
     14 
     15== Using Darcs == 
     16 
     17Our conventions and some useful tips for using darcs are here: [wiki:WorkingConventions/Darcs]. 
    1418 
    1519== Submitting patches == 
     
    6367 
    6468If you are working on a feature that you think you think is a candidate for including in GHC's main repository, you may want to talk to us while you are developing it.  We may well, for example, have advice about how to structure the change in a way that we're happy to incorporate in our code base. 
    65  
    66 == Patch naming == 
    67  
    68 We have a simple naming convention for certain kinds of patches: 
    69  
    70  * If your patch fixes breakage in the build, then begin the patch name with `"FIX BUILD"`. e.g. 
    71 {{{ 
    72   FIX BUILD Use the right find on Windows systems; fixes bindist creation 
    73 }}} 
    74   The point here is that if someone pulls GHC from darcs and experiences a build failure, they can try 
    75   `darcs pull -a -p "FIX BUILD"` in order to grab patches that fix it, without grabbing anything else 
    76   that might introduce further breakage. 
    77  
    78  * If your patch fixes a bug, then begin the patch name with `"FIX #NNNN"`, where `NNNN` is the ticket 
    79    number. e.g. 
    80 {{{ 
    81   FIX #767 (withMVar family have a bug) 
    82 }}} 
    83  
    84 == Committing changes == 
    85  
    86 If 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}}}: 
    87  
    88 {{{ 
    89   $ darcs push <account>@darcs.haskell.org:/home/darcs/ghc 
    90 }}} 
    91  
    92 (change {{{ghc}}} to the name of the repository if you're pushing changes from one of the sub-repositories, like {{{testsuite}}}, or a package such as {{{base}}}.  Note: {{{darcs push}}} requires that SSH is working and can log in to your account on {{{darcs.haskell.org}}}. 
    93  
    94 Do not forget to {{{darcs record}}} your changes first! 
    9569 
    9670== The stable branch ==