diff options
Diffstat (limited to 'firmware/CONTRIBUTING')
-rw-r--r-- | firmware/CONTRIBUTING | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/firmware/CONTRIBUTING b/firmware/CONTRIBUTING new file mode 100644 index 0000000000..b38409ade5 --- /dev/null +++ b/firmware/CONTRIBUTING | |||
@@ -0,0 +1,18 @@ | |||
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 C code. Don't redefine the language. No new types, no C++isms or | ||
10 | Javaisms. | ||
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 | |||