diff options
| -rw-r--r-- | HACKERS | 7 | ||||
| -rw-r--r-- | doc/coding_style.txt | 33 |
2 files changed, 40 insertions, 0 deletions
diff --git a/HACKERS b/HACKERS new file mode 100644 index 00000000..c103c343 --- /dev/null +++ b/HACKERS @@ -0,0 +1,7 @@ +Welcome hackers! + +This project accepts and *encourages* contributions. If you would like to get involved you can join us on our mailing list at: <doh, we need a mailing list> + +You can also find us in the chatroom at lxmppd@chatbox.heavy-horse.co.uk + +Patches are welcome, though before sending we would appreciate if you read docs/coding_style.txt for guidelines on how to format your code. diff --git a/doc/coding_style.txt b/doc/coding_style.txt new file mode 100644 index 00000000..c9113e81 --- /dev/null +++ b/doc/coding_style.txt @@ -0,0 +1,33 @@ +This file describes some coding styles to try and adhere to when contributing to this project. +Please try to follow, and feel free to fix code you see not following this standard. + +== Indentation == + + 1 tab indentation for all blocks + +== Spacing == + +No space between function names and parenthesis and parenthesis and paramters: + + function foo(bar, baz) + +Single space between braces and key/value pairs in table constructors: + + { foo = "bar", bar = "foo" } + +== Local variable naming == + +In this project there are many places where use of globals is restricted, and locals used for faster access. + +Local versions of standard functions should follow the below form: + + math.random -> m_random + string.char -> s_char + +== Miscellaneous == + +Single-statement blocks may be written on one line when short + + if foo then bar(); end + +'do' and 'then' keywords should be placed at the end of the line, and never on a line by themself. |