mirror of
https://github.com/Rockbox/rockbox.git
synced 2025-10-13 18:17:39 -04:00
initial move from other directories
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@1844 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
parent
3a5b919e85
commit
40bafc5def
5 changed files with 749 additions and 0 deletions
52
docs/CONTRIBUTING
Normal file
52
docs/CONTRIBUTING
Normal file
|
@ -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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue