From deb21b8297cbc094ef6d39a00f52c1c641d854db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Erick=20P=C3=A9rez=20Castellanos?= Date: Tue, 18 Jun 2013 09:06:23 -0400 Subject: [PATCH] docs: added HACKING file --- HACKING | 14 ++++++++++++++ Makefile.am | 1 + 2 files changed, 15 insertions(+) create mode 100644 HACKING diff --git a/HACKING b/HACKING new file mode 100644 index 00000000..ffc67fab --- /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 4484fa1c..0b9b1b27 100644 --- a/Makefile.am +++ b/Makefile.am @@ -19,6 +19,7 @@ EXTRA_DIST = \ $(INTLTOOL_FILES) \ INSTALL \ THANKS \ + HACKING \ TODO \ autogen.sh