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 conventions:
  14
  15 Language
  16 --------
  17 Write all code in C. Sometimes assembly is faster, but C is always more
  18 readable and maintainable.
  19
  20 Language features
  21 -----------------
  22 Write normal C code. Don't redefine the language. No new types (structs are
  23 structs, not typedefs), no C++isms or Javaisms. Also, avoid using "const".
  24
  25 Names
  26 -----
  27 Variables and function names should be all lower case.
  28 Preprocessor symbols should be all uppercase.
  29
  30 Comments
  31 --------
  32 We only use plain old /* C standard comments */.
  33
  34 Style
  35 -----
  36 When changing code, follow the code style of the file you are editing.
  37
  38 When writing new files, you may use the brace placement style of your choice.
  39
  40 Always indent your code with four spaces. Don't use TAB characters, as that
  41 will mess up code display in CVS, printing, and a zillion other places.
  42
  43 Keep lines below 80 columns length. Use whitespace and newlines to make the
  44 code easy to browse/read.
  45
  46 Text format
  47 -----------
  48 Use "unix style" line feeds: "LF" only. Do not use "CR+LF".
  49
  50 Patches
  51 -------
  52 Create a patch using 'cvs diff -ub'.
  53 Trim your patches so they only contain relevant changes.
  54
  55 Submit your patch to the project via Sourceforge's patch tracker:
  56 http://sourceforge.net/tracker/?group_id=44306&atid=439120