firmware/CONTRIBUTING

   1 $Id$
   2
   3 In order for the project to run as smoothly as possible, it's best if all
   4 contributors adhere to a few simple conventions:
   5
   6 - Write all code in C. Sometimes assembly is faster, but C is always more
   7   readable and maintainable.
   8
   9 - Write normal C code. Don't redefine the language. No new types,
  10   no C++isms or Javaisms. Also, do not use "const".
  11
  12 - Variables and function names should be all lower case.
  13   Preprocessor symbols should be all uppercase.
  14
  15 - Use the brace placement style of your choice, but indent your code with
  16   four spaces. Don't use TAB characters, as that will mess up code display in
  17   CVS, printing, and a zillion other places.
  18
  19 - Use "unix style" line feeds: "LF" only. Do not use "CR+LF".