summaryrefslogtreecommitdiff
path: root/HACKING
blob: 50a21a62f3660ba33250519e98c437c7d99654f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

Coding Style
===

 - Please follow the coding style already used - it's not a must, but it's
   nice to have consistency.

 - 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).