docs: added HACKING file

2014-12-04 17:10:25 -05:00
parent 4330859ae0
commit deb21b8297
2 changed files with 15 additions and 0 deletions
@@ -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.