Changes between Version 1 and Version 2 of Development guidelines

04/06/09 22:02:27 (8 years ago)
jeltsch (IP:

addition of darcs guidelines


  • Development guidelines

    v1 v2  
    11= Development guidelines = 
     3== darcs guidelines == 
     5Metadata of darcs patches isn’t versioned. Therefore, please try to make it nice. Wolfgang Jeltsch, the prinicipal Grapefruit developer, has some opinions about patch niceness. He would love to see you adhering to them. So please be so kind and follow these rules: 
     7Let patch names be names: 
     8    Please avoid patch names like “fix documentation” or “fixed documentation”. A darcs patch is a change and its name should describe that change. So you should say something like “fixing of documentation” or “documentation fix” instead. Always think about what the change is. It’s the fixing of documentation of a documentation fix, for example. 
     10Use non-ASCII: 
     11    Please avoid ASCII characters that have multiple meanings. Instead use the correct non-ASCII character. Write {{{“as is”}}} instead of {{{"as is"}}}, {{{I’m}}} instead of {{{I'm}}}, {{{buttons, labels, …}}} instead of {{{buttons, labels, ...}}}. 
     13Use UTF-8: 
     14    Alas, darcs patch names and long comments are byte sequences, not character sequences. Depending on your locale, the same patch name or long comment might result in different text. So we must choose a common character encoding for patch names and long comments. This is UTF-8.