summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorDavid Zeuthen <david@fubar.dk>2003-11-05 23:22:50 +0000
committerDavid Zeuthen <david@fubar.dk>2003-11-05 23:22:50 +0000
commita137318d81927b34d311ac3e5d32c19d03fad310 (patch)
treecab6ff5893fd5dacc0417bab157f47bef7661fdf /HACKING
initial import
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING17
1 files changed, 17 insertions, 0 deletions
diff --git a/HACKING b/HACKING
new file mode 100644
index 00000000..2bbf0e8d
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,17 @@
+
+Coding Style
+===
+
+ - Please follow the coding already used
+
+ - Write docs for all functions and structs and so on. try
+ "doxygen Doxyfile" prior to commit and be sure there are no
+ warnings printed.
+
+ - All external interfaces (network protocols, file formats, etc.)
+ should have documented specifications sufficient to allow an
+ alternative implementation to be written. Our implementation should
+ be strict about specification compliance (should not for example
+ heuristically parse a file and accept not-well-formed
+ data). Avoiding heuristics is also important for security reasons;
+ if it looks funny, ignore it (or exit, or disconnect).