From 3e852c9d24de04b6bcfb13b0d28460575e875844 Mon Sep 17 00:00:00 2001 From: Christian Thaeter Date: Sat, 31 Jul 2010 02:04:01 +0200 Subject: [PATCH] inner_core: few words about coding style, tdd and documentation --- doc/devel/the_inner_core/the_inner_core.txt | 30 +++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/doc/devel/the_inner_core/the_inner_core.txt b/doc/devel/the_inner_core/the_inner_core.txt index 69fe42992..ba59c1fe4 100644 --- a/doc/devel/the_inner_core/the_inner_core.txt +++ b/doc/devel/the_inner_core/the_inner_core.txt @@ -43,12 +43,38 @@ The extra components are: rest. +Coding Style +~~~~~~~~~~~~ + +The Lumiera team agreed on using GNU coding style with some exceptions (no +tabs, line wrap must not always be enforced). Otherwise we are a bit pedantic +to be consistent to make the codebase uniform. Function nameing conventions +and other details are described in sereral RFCs. + +Documentation +~~~~~~~~~~~~~ + +Every public function should be documented with doxygen comments. The design +is documented in this text, in various RFC's. Bootstrapping the Lumiera design +used serveral other places, some tiddlywikis, an uml model and cehteh's +private wiki, most of this information is asciidoced meanwhile and in progress +to be integrated in a now documentation hierarchy. + + +Test Driven Development +~~~~~~~~~~~~~~~~~~~~~~~ + +We strive to use _Test-Driven-Development_ this means tests are written first, +defining the specification of the entity being tested. Then things get +implemented until they pass their tests. Practice shows that this approach +isn't always suiteable, nevertheless we try to follow it closely and maintain +rigid testsuites. + + Lumiera Main ------------ - - Common ------