docs/CONTRIBUTING

   1 $Id$
   2
   3                __________               __   ___.
   4      Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   5      Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   6      Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   7      Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   8                        \/            \/     \/    \/            \/
   9                                  Contribution Policies
  10
  11
  12 In order for the project to run as smoothly as possible, it's best if all
  13 contributors adhere to a few simple source code conventions:
  14
  15 Exceptions
  16 ----------
  17 This project borrows and imports quite a lot of code from other free software
  18 projects. We do not change style of such code unless we really have to, even
  19 though they might be using style very different from others.
  20
  21 Language
  22 --------
  23 Write all code in C. Sometimes assembly is faster, but C is always more
  24 readable and maintainable.
  25
  26 Language features
  27 -----------------
  28 Write normal C code. Don't redefine the language. No new types (structs are
  29 structs, not typedefs), no C++isms or Javaisms.
  30
  31 Identifiers
  32 -----------
  33 We do not want mixed case identifiers.
  34 Variables and function names should be all lower case.
  35 Struct and enum names should be all lower case.
  36 Preprocessor symbols and enum constants should be all upper case.
  37
  38 Comments
  39 --------
  40 We only use plain old /* C standard comments */.
  41 If you want to comment out large blocks containing other comments, use #if 0.
  42
  43 Style
  44 -----
  45 When changing code, follow the code style of the file you are editing.
  46
  47 When writing new files, you may use the brace placement style of your choice.
  48
  49 Braces for function declarations are put in a new line under the name, as in:
  50
  51   int foo(char *name)
  52   {
  53      return FOO_NAME:
  54   }
  55
  56 Always indent your code with four spaces. Don't use TAB characters, as that
  57 will mess up code display in CVS, printing, and a zillion other places.
  58
  59 Keep lines below 80 columns length. Use whitespace and newlines to make the
  60 code easy to browse/read.
  61
  62 Text format
  63 -----------
  64 Use "unix style" line feeds: "LF" only. Do not use "CR+LF".
  65
  66 Use UTF-8 character set, but try to refrain from using any non-ascii
  67 letters as they will only appear weird in some camps no matter what.
  68
  69 Patches
  70 -------
  71 Create a patch using 'svn diff > mychanges.patch
  72 Trim your patches so they only contain relevant changes.
  73
  74 Submit your patch to the project via our patch tracker:
  75 http://www.rockbox.org/tracker/index.php?type=4
  76
  77 Credits
  78 -------
  79 We believe in crediting all contributors by name. Before committing a patch to
  80 SVN, we ask that you give us your full real name (no pseudonyms or nicknames)
  81 for adding to the credits list.