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

Proposed by Milo Casagrande
Status: Merged
Approved by: Stevan Radaković
Approved revision: 27
Merged at revision: 27
Proposed branch: lp:~milo/linaro-ci-dashboard/hacking-file
Merge into: lp:linaro-ci-dashboard
Diff against target: 54 lines (+50/-0)
1 file modified
HACKING (+50/-0)
To merge this branch: bzr merge lp:~milo/linaro-ci-dashboard/hacking-file
Reviewer Review Type Date Requested Status
Stevan Radaković Approve
Review via email: mp+121136@code.launchpad.net

Description of the change

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.

To post a comment you must log in.
Revision history for this message
Stevan Radaković (stevanr) wrote :

Good hacking file.
Approve +1.

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== added file 'HACKING'
2--- HACKING 1970-01-01 00:00:00 +0000
3+++ HACKING 2012-08-24 09:01:20 +0000
4@@ -0,0 +1,50 @@
5+= Directory Layout =
6+
7+At the moment, the directory layout for `lianro-ci-dashboard' is as follows:
8+
9+dashboard/
10+ |
11+ +--- frontend/
12+ | |
13+ | +--- integration_loop/
14+ | |
15+ | + tests/
16+ | + ...
17+ | +--- android_build/
18+ | +--- kernel_build/
19+ | |
20+ | + models/
21+ | + templates/
22+ | + tests/
23+ |
24+ +--- jenkinsserver/
25+ |
26+ + settings.py
27+ + urls.py
28+ |
29+ +--- lib/
30+
31+(the above schema is not a complete representation of the structure)
32+
33+There are two main applications: `frontend' and `jenkinsserver'.
34+
35+All the loops are, in Django terms, sub-applications of `frontend', also
36+declared as such in the `dashboard/settings.py' file.
37+
38+Base templates for the loops are stored in `frontend/templates/', base models in
39+`frontend/models'.
40+
41+`lib/' contains libraries useful throughout all the project.
42+
43+= Creating a New Loop =
44+
45+A new loop model should inherit the base `Loop' model as defined in
46+`frontend/models/loop.py'.
47+
48+For the templates, the base ones defined in `frontend/templates/' should be used
49+and extended.
50+
51+Specific URLs definition should be included in the base `urls.py' file, under
52+`dashboard/'.
53+
54+Tests should be written and defined inside each sub-application.

Subscribers

People subscribed via source and target branches