summaryrefslogtreecommitdiffstats
path: root/docs/CONTRIBUTING
diff options
context:
space:
mode:
authorRobert Hak <adiamas@rockbox.org>2002-08-21 10:19:23 +0000
committerRobert Hak <adiamas@rockbox.org>2002-08-21 10:19:23 +0000
commit40bafc5def79a2cb425028188807515b4630dad5 (patch)
tree97da7c7ff14bf093ad08ad0b2bece021e5263f40 /docs/CONTRIBUTING
parent3a5b919e85ee272bc4495b9bf11458197cd16a39 (diff)
downloadrockbox-40bafc5def79a2cb425028188807515b4630dad5.tar.gz
rockbox-40bafc5def79a2cb425028188807515b4630dad5.tar.bz2
rockbox-40bafc5def79a2cb425028188807515b4630dad5.zip
initial move from other directories
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@1844 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'docs/CONTRIBUTING')
-rw-r--r--docs/CONTRIBUTING52
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/CONTRIBUTING b/docs/CONTRIBUTING
new file mode 100644
index 0000000000..0108c8eefa
--- /dev/null
+++ b/docs/CONTRIBUTING
@@ -0,0 +1,52 @@
+$Id$
+
+In order for the project to run as smoothly as possible, it's best if all
+contributors adhere to a few simple conventions:
+
+Language
+--------
+Write all code in C. Sometimes assembly is faster, but C is always more
+readable and maintainable.
+
+Language features
+-----------------
+Write normal C code. Don't redefine the language. No new types (structs are
+structs, not typedefs), no C++isms or Javaisms. Also, avoid using "const".
+
+Names
+-----
+Variables and function names should be all lower case.
+Preprocessor symbols should be all uppercase.
+
+Style
+-----
+When changing code, follow the code style of the file you are editing.
+
+When writing new files, you may use the brace placement style of your choice.
+
+Always indent your code with four spaces. Don't use TAB characters, as that
+will mess up code display in CVS, printing, and a zillion other places.
+
+Keep lines below 80 columns length. Use whitespace and newlines to make the
+code easy to browse/read.
+
+Text format
+-----------
+Use "unix style" line feeds: "LF" only. Do not use "CR+LF".
+
+Patches
+-------
+Create a patch using 'cvs diff -ub'.
+Trim your patches so they only contain relevant changes.
+Submit all patches to the mailing list.
+Put [PATCH] first on the subject line of your mail.
+If the patch is very large (>50k), gzip it before you send it.
+
+
+
+
+
+
+
+
+