Llewellyn/Tomb
1
1
Fork 0
mirror of https://github.com/Llewellynvdm/Tomb.git synced 2024-06-17 01:22:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Simple style guidelines, as discussed in ML

Browse Source
This commit is contained in:
boyska 2011-05-02 11:14:42 +02:00
parent 2b62a972f5
commit 600ffb1170
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
HACKING Normal file
View File

@ -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()`