[gnome-calendar/ui-rewrite] docs: added HACKING file



commit 3782b0a15f7fdbd4fcabb5dfa1274b2b3f2ff274
Author: Erick Pérez Castellanos <erick red gmail com>
Date:   Tue Jun 18 09:06:23 2013 -0400

    docs: added HACKING file

 HACKING     |   14 ++++++++++++++
 Makefile.am |    1 +
 2 files changed, 15 insertions(+), 0 deletions(-)
---
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..ffc67fa
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,14 @@
+Code formating and ordering
+
+* The source file will keep and order of methods. The order will be as
+following:
+  1. Private functions will go first.
+  2. class_init and init will go second.
+  3. vfuncs implementations will go third.
+  4. Public API will go fourth
+
+* Methods naming will be according to:
+  1. Private methods will have no prefix
+  2. vfuncs and public API will have the right prefix
+
+* The methods prototype will always be placed at the top of the source.
diff --git a/Makefile.am b/Makefile.am
index 4484fa1..0b9b1b2 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -19,6 +19,7 @@ EXTRA_DIST =                    \
   $(INTLTOOL_FILES)             \
   INSTALL                       \
   THANKS                        \
+  HACKING                       \
   TODO                          \
   autogen.sh
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]