1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
SAHANA AGASTI 2.0 MAYON
Emergency Management Software
INFORMATION FOR DEVELOPERS
Updated: 2011-05-26
GETTING STARTED
===============
*** IMPORTANT NOTE: ***
THIS IS A DOCUMENT IN PROGRESS and MAY NOT BE COMPLETE.
<Quick reference for new developers>
This is developer-specific reference information.
SYSTEM REQUIREMENTS
===================
Software
--------
The following software is required for running Sahana Agasti:
* Ubuntu 9.10 LTS or later (most current 10.04 LTS strongly recommended)
* Apache HTTP Server 2.2.14 or later (most current 2.2 preferred)
* MySQL 5.1.41 or later (most current 5.1 preferred)
* PHP 5.2.12 or later (most current 5.3 strongly recommended)
* APC (The Alternative PHP Cache) 3.1.8 or later
Hardware
--------
The following hardware resources are recommended for running Sahana Agasti:
* Intel Pentium or AMD Athlon CPU
* minimum of 50 MB available disk space
* minimum 512 MB RAM
GETTING THE CODE
================
<<
Checkout/Branch
bzr branch lp:sahana-agasti/mayon
[...]
>>
SYSTEM CONFIGURATION
====================
<<
Configure
Test
Install
[...]
* NOTES: The install script by default only installs the standard data for the
application to operate. Sample data are provided in [AG_ROOT]/data/samples. To
execute both standard and sample data, modify the script
[AG_ROOT]/web/install.inc.php by replacing the line
Doctrine_Core::loadData(sfConfig::get('sf_data_dir') . '/fixtures', false);
with the following three lines
$dataDirectories = array(sfConfig::get('sf_data_dir') . '/fixtures',
sfConfig::get('sf_data_dir') . '/samples');
Doctrine_Core::loadData($dataDirectories, false);
in the doInstall method; otherwise, use the developer tool, clean-project.sh.
[...]
>>
DEVELOPMENT
===========
The following are links to help aid new developers in contributing to Sahana
Agasti. For more information on best practices and standards, please visit
http://wiki.sahanafoundation.org/doku.php/agasti:start
For Agasti code documentation, please reference the included file,
doc/doxygen/html/index.html
For documentation on the Doctrine ORM, please visit
http://www.doctrine-project.org/projects/orm/1.2/docs/en
For documentation regarding the Symfony framework, please visit
http://www.symfony-project.org/api/1_4/
For PHP 5 documentation, please visit http://www.php.net/docs.php
CHECKING CODE TO LP
===================
Check-in Check List
-------------------
The following is a checklist for any code you'd like to contribute to Sahana
Agasti:
- All code is properly commented
- All files that have been modified or created for the project have headers that
include the following:
* A description of what the class does
* A license statement:
LICENSE: This source file is subject to LGPLv3.0 license
that is available through the world-wide-web at the following URI:
http://www.gnu.org/copyleft/lesser.html
* The author's name and contact information (using the @author Doxygen tag)
* The text "Copyright of the Sahana Software Foundation, sahanafoundation.org"
- The code has been checked with PHP Lint, formatted properly, and tested.
- Include in your merge request the Feature Request related to your code
SUBMITTING A BUG
================
To submit a bug to the Mayon codebase, please do the following:
1. Sign in at https://bugs.launchpad.net/sahana-agasti/mayon
2. On the right side of the page click the "Report a Bug" link.
3. Enter the initial summary for the bug and verify it hasn't already been
submitted. Click "Next" if there has not been a report.
4. In the Further Information section provide as many details about the bug as
possible. Describe the scenario when it happens and how regularly it
happens. Please INCLUDE A SCREENSHOT if you're able.
5. If you know the Importance of the bug or tags would be helpful include this
information.
6. Click the Submit Bug Report button. Please be available in case the
development team has questions regarding your report.
SUBMITTING A FEATURE REQUEST
============================
To submit a feature request to the Mayon codebase, please do the following:
1. Sign in at https://blueprints.launchpad.net/sahana-agasti/mayon
2. On the right side of the page click the "Register a blueprint" link.
3. Name your feature request and provide as many details as you're able to.
Remember, the more details you provide the more thoroughly we'll understand
your request.
4. Click the Register Blueprint button. Please be available in case the
development team has questions regarding your report.
DEFAULT SETUP
=============
The default environment in ProjectConfiguration.class.php is currently set to
dev. As a result, some forms of caching are disabled. frontend_dev.php is
currently open and available to hosts outside of localhost (this allows full
stack tracing and exposes potentially sensitive information).
|