Merge lp:~milo/linaro-ci-dashboard/hacking-file into lp:linaro-ci-dashboard

[Milo Casagrande]

Fairly simple merge, just adding the HACKING file as discussed some days ago on IRC, with some details on the directory/apps layout of the project.

At this stage is very simple, ideas on what to add are welcome.

[Stevan Radaković (stevanr)]

Good hacking file.
Approve +1.

review: Approve

=== added file 'HACKING'
--- HACKING	1970-01-01 00:00:00 +0000
+++ HACKING	2012-08-24 09:01:20 +0000
@@ -0,0 +1,50 @@
+= Directory Layout =
+
+At the moment, the directory layout for `lianro-ci-dashboard' is as follows:
+
+dashboard/
+  |
+  +--- frontend/
+  |    |
+  |    +--- integration_loop/
+  |          |
+  |          + tests/
+  |          + ...
+  |    +--- android_build/
+  |    +--- kernel_build/
+  |    |
+  |    + models/
+  |    + templates/
+  |    + tests/
+  |
+  +--- jenkinsserver/
+  |
+  + settings.py
+  + urls.py
+  |
+  +--- lib/
+
+(the above schema is not a complete representation of the structure)
+
+There are two main applications: `frontend' and `jenkinsserver'.
+
+All the loops are, in Django terms, sub-applications of `frontend', also
+declared as such in the `dashboard/settings.py' file.
+
+Base templates for the loops are stored in `frontend/templates/', base models in
+`frontend/models'.
+
+`lib/' contains libraries useful throughout all the project.
+
+= Creating a New Loop =
+
+A new loop model should inherit the base `Loop' model as defined in
+`frontend/models/loop.py'.
+
+For the templates, the base ones defined in `frontend/templates/' should be used
+and extended.
+
+Specific URLs definition should be included in the base `urls.py' file, under
+`dashboard/'.
+
+Tests should be written and defined inside each sub-application.