]> git.street.me.uk Git - andy/viking.git/commitdiff
Improve HACKING documentation
authorGuilhem Bonnefille <guilhem.bonnefille@gmail.com>
Mon, 14 Mar 2011 20:16:43 +0000 (21:16 +0100)
committerGuilhem Bonnefille <guilhem.bonnefille@gmail.com>
Mon, 14 Mar 2011 21:10:48 +0000 (22:10 +0100)
Inspired corresponding file in Folks project.

HACKING

diff --git a/HACKING b/HACKING
index 59902651f921356c83bedf0cf41ba2f354f2d82d..87cc29b7c6bb989229f0f66a0fa48fd084bdd21e 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -1,3 +1,16 @@
+This file is meant to summarize the Viking development policies.
+
+
+Clean commits
+=============
+
+Commits/patches should be as fine-grained as possible (and no finer). Every
+distinct change should be in its own commit and every commit should be a
+meaningful change on its own.
+
+Coding style
+============
+
 Naming:
 A "module" is a .c file.
 
@@ -7,7 +20,8 @@ Both are followed by the module name. Unless of course the function is static, i
 
 All (well, practically all) global constants and macros start with "VIK_" and then the module name.
 
-----
+Technical notices
+=================
 
 The layers panel holds all the layers. Layers connect to the layers panel via what I call "interfaces" which are really just a 
 structure of function pointers and pointers to other bits such as icons. viklayer.c switches between the layers like