summaryrefslogtreecommitdiff
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.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 @@
1$Id$
2
3In order for the project to run as smoothly as possible, it's best if all
4contributors adhere to a few simple conventions:
5
6Language
7--------
8Write all code in C. Sometimes assembly is faster, but C is always more
9readable and maintainable.
10
11Language features
12-----------------
13Write normal C code. Don't redefine the language. No new types (structs are
14structs, not typedefs), no C++isms or Javaisms. Also, avoid using "const".
15
16Names
17-----
18Variables and function names should be all lower case.
19Preprocessor symbols should be all uppercase.
20
21Style
22-----
23When changing code, follow the code style of the file you are editing.
24
25When writing new files, you may use the brace placement style of your choice.
26
27Always indent your code with four spaces. Don't use TAB characters, as that
28will mess up code display in CVS, printing, and a zillion other places.
29
30Keep lines below 80 columns length. Use whitespace and newlines to make the
31code easy to browse/read.
32
33Text format
34-----------
35Use "unix style" line feeds: "LF" only. Do not use "CR+LF".
36
37Patches
38-------
39Create a patch using 'cvs diff -ub'.
40Trim your patches so they only contain relevant changes.
41Submit all patches to the mailing list.
42Put [PATCH] first on the subject line of your mail.
43If the patch is very large (>50k), gzip it before you send it.
44
45
46
47
48
49
50
51
52