Changes between Version 11 and Version 12 of WorkingConventions/Git


Ignore:
Timestamp:
May 12, 2011 9:09:36 AM (4 years ago)
Author:
simonpj
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WorkingConventions/Git

    v11 v12  
    2020 * Discuss anything you think might be controversial before pushing it.
    2121
    22 == Patch naming ==
    23 
    24 We have a simple naming convention for certain kinds of patches:
    25 
    26  * If your patch fixes breakage in the build, then begin the patch name with `"FIX BUILD"`. e.g.
     22 * We have a simple naming convention for certain kinds of patches:
     23   * If your patch fixes breakage in the build, then begin the patch name with `"FIX BUILD"`. e.g.
    2724{{{
    2825  FIX BUILD Use the right find on Windows systems; fixes bindist creation
    2926}}}
    30 
    31  * If your patch fixes a bug, then include the ticket number in the form `#NNNN` in the patch name, e.g.
     27   * If your patch fixes a bug, then include the ticket number in the form `#NNNN` in the patch name, e.g.
    3228{{{
    3329  withMVar family have a bug (fixes #767)
    3430}}}
    35   Trac will then create a link from the commit to the ticket, making navigation easier.
     31     Trac will then create a link from the commit to the ticket, making navigation easier.
     32
     33== Line endings ==
     34
     35Files in GHC repos should use Unix conventions for line endings.
     36If you are on Windows, ensure that git handles line-endings sanely by running:
     37{{{
     38git config --global core.autocrlf false
     39}}}
     40To find out what files in your tree have windows (CRLF) line endings,  use
     41{{{
     42find . -name '*hs' | xargs file | grep CRLF
     43}}}
     44Do this before you commit them!
    3645
    3746== Normal workflow ==