tSimple style guidelines, as discussed in ML - tomb - the crypto undertaker (HTM) git clone git://parazyd.org/tomb.git (DIR) Log (DIR) Files (DIR) Refs (DIR) README (DIR) LICENSE --- (DIR) commit 600ffb11700635694e2cb57e376519979d9e40d4 (DIR) parent 2b62a972f5fd2f850f4648cc398a22e716714bc7 (HTM) Author: boyska <piuttosto@logorroici.org> Date: Mon, 2 May 2011 11:14:42 +0200 Simple style guidelines, as discussed in ML Diffstat: A HACKING | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+), 0 deletions(-) --- (DIR) diff --git a/HACKING b/HACKING t@@ -0,0 +1,21 @@ +Style guidelines +=============== + +Indentation +----------- +Code must be indented using four spaces. +In vim, this can be accomplished using + + set shiftwidth=4 + set expandtab + +Naming +------ + +global variables should be `$UPPERCASE`. + +local variables should be `$lowercase`, best if it can be written without underscores. +If you feel the need to name a variable `$longdescriptionofwhatthisisusefulfor`, +then you're allowed to use underscores. But do you really need? + +functions should be lowercase+underscores: `do_this()`