From 16673f3e908d6135d9a74cd1d02845b0e84ce717 Mon Sep 17 00:00:00 2001 From: Martin Stubenschrott Date: Wed, 6 May 2009 00:51:46 +0200 Subject: [PATCH] Add some info to the coding style --- HACKING | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/HACKING b/HACKING index 2c92428b..b879e131 100644 --- a/HACKING +++ b/HACKING @@ -20,6 +20,15 @@ important, please ask. In general: Just look at the existing source code! We try to be quite consistent, but of course, that's not always possible. +Also we try to target experienced JavaScript developers which do not +necessarily need to have a good understanding of Vimperator's source code, nor +do they probably know in-depth concepts of other languages like Lisp or Python. +Therefore, the coding style should feel natural to any JavaScript developer +so it is easy to read and understand. Of course, this does not mean, you have +to avoid all new JavaScript features like list comprehension or generators. +Use them, when they make sense, but don't use them, when the resulting code +is hard to read. + === The most important style issues are: === * Use 4 spaces to indent things, no tabs, not 2, nor 8 spaces. If you use Vim,